Skip to content

Commit

Permalink
Update README, site.
Browse files Browse the repository at this point in the history
  • Loading branch information
io7m committed May 11, 2024
1 parent 83a1c0d commit 87b0f6d
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 5 deletions.
22 changes: 22 additions & 0 deletions README.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

## canonmill

The `canonmill` package provides a
[Keystore](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/KeyStore.html)
implementation designed to be less painful from an operational perspective than any of the
`Keystore` implementations currently included in the standard JDK.

## Features

* Exposes a simple directory-based keystore with a single XML file that maps certificate aliases to files. Keys and certificates are expected to be PEM-encoded regular files.
* Implicit compatibility with ACME systems; ACME clients can simply copy certificate files into the directory and, as long as the certificates have an entry in the XML index file, the new certificates will become available as soon as the Keystore is reloaded.
* A small, easily auditable codebase with use of modularity for correctness.
* An extensive automated test suite with high coverage.
* Platform independence. No platform-dependent code is included in any form.
* [OSGi](https://www.osgi.org/)-ready.
* [JPMS](https://en.wikipedia.org/wiki/Java_Platform_Module_System)-ready.
* ISC license.

## Usage

See the [documentation](https://www.io7m.com/software/canonmill/).
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,26 @@ canonmill
| OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/canonmill/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/canonmill/actions?query=workflow%3Amain.linux.temurin.lts)|
| OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/canonmill/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/canonmill/actions?query=workflow%3Amain.windows.temurin.current)|
| OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/canonmill/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/canonmill/actions?query=workflow%3Amain.windows.temurin.lts)|

## canonmill

The `canonmill` package provides a
[Keystore](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/KeyStore.html)
implementation designed to be less painful from an operational perspective than any of the
`Keystore` implementations currently included in the standard JDK.

## Features

* Exposes a simple directory-based keystore with a single XML file that maps certificate aliases to files. Keys and certificates are expected to be PEM-encoded regular files.
* Implicit compatibility with ACME systems; ACME clients can simply copy certificate files into the directory and, as long as the certificates have an entry in the XML index file, the new certificates will become available as soon as the Keystore is reloaded.
* A small, easily auditable codebase with use of modularity for correctness.
* An extensive automated test suite with high coverage.
* Platform independence. No platform-dependent code is included in any form.
* [OSGi](https://www.osgi.org/)-ready.
* [JPMS](https://en.wikipedia.org/wiki/Java_Platform_Module_System)-ready.
* ISC license.

## Usage

See the [documentation](https://www.io7m.com/software/canonmill/).

4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
</developers>

<issueManagement>
<url>https://www.github.com/io7m/canonmill/issues</url>
<url>https://www.github.com/io7m-com/canonmill/issues</url>
<system>GitHub Issues</system>
</issueManagement>

Expand All @@ -83,7 +83,7 @@

<ciManagement>
<system>GitHub Actions</system>
<url>https://github.com/canonmill/actions</url>
<url>https://www.github.com/io7m-com/canonmill/actions</url>
</ciManagement>

<prerequisites>
Expand Down
6 changes: 3 additions & 3 deletions src/site/resources/features.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@
</li>
<li>
<a href="https://www.osgi.org/"
title="https://www.osgi.org/">OSGi</a>-ready
title="https://www.osgi.org/">OSGi</a>-ready.
</li>
<li>
<a href="https://en.wikipedia.org/wiki/Java_Platform_Module_System"
title="https://en.wikipedia.org/wiki/Java_Platform_Module_System">
JPMS</a>-ready
JPMS</a>-ready.
</li>
<li>
ISC license
ISC license.
</li>
</ul>
</div>

0 comments on commit 87b0f6d

Please sign in to comment.