github
/
acme4j
mirror of https://github.com/shred/acme4j
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README

pull/55/head
Richard Körber 2017-04-27 22:31:30 +02:00
parent 34f17a7e6f
commit 39a45a53a5
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -8,21 +8,28 @@ This Java client helps connecting to an ACME server, and performing all necessar
It is an independent open source implementation that is not affiliated with or endorsed by _Let's Encrypt_. It is an independent open source implementation that is not affiliated with or endorsed by _Let's Encrypt_.
## Work in Progress!
In this branch, the latest draft of the ACME protocol is being implemented. It is not meant for production. There are no servers that fully support this draft at the moment.
Use the [master branch](https://github.com/shred/acme4j/tree/master) for production purposes.
## Features ## Features
* Supports ACME protocol up to [draft 04](https://tools.ietf.org/html/draft-ietf-acme-acme-04) * Supports ACME protocol up to [draft 06](https://tools.ietf.org/html/draft-ietf-acme-acme-06)
* Easy to use Java API * Easy to use Java API
* Requires JRE 8 or higher * Requires JRE 8 or higher
* Built with maven, packages available at [Maven Central](http://search.maven.org/#search|ga|1|g%3A%22org.shredzone.acme4j%22) * Built with maven, packages available at [Maven Central](http://search.maven.org/#search|ga|1|g%3A%22org.shredzone.acme4j%22)
* Small, only requires [jose4j](https://bitbucket.org/b_c/jose4j/wiki/Home) and [slf4j](http://www.slf4j.org/) as dependencies * Small, only requires [jose4j](https://bitbucket.org/b_c/jose4j/wiki/Home) and [slf4j](http://www.slf4j.org/) as dependencies
* Extensive unit tests * Extensive unit tests
## Current Status
In this branch, the latest draft of the ACME protocol is being implemented. It is not meant for production. There are no servers that fully support this draft at the moment.
Use the [master branch](https://github.com/shred/acme4j/tree/master) for production purposes.
Known issues:
* Documentation is incomplete and partially outdated
* The API is subject to change
* The example is not functional at the moment
* Integration tests do not fully cover all functions
## Usage ## Usage
* See the [online documentation](https://shredzone.org/maven/acme4j/) about how to use _acme4j_. * See the [online documentation](https://shredzone.org/maven/acme4j/) about how to use _acme4j_.