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-05-03 13:24:47 +02:00
parent e8790e8446
commit 3d82e09eb3
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -10,23 +10,25 @@ It is an independent open source implementation that is not affiliated with or e
## Features ## Features
* Supports ACME protocol up to [draft 06](https://tools.ietf.org/html/draft-ietf-acme-acme-06) * Fully supports the 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 and integration tests
## Current Status ## 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. This branch implements the latest draft of the ACME protocol.
It is not meant for production yet! There are no servers that fully cover this draft at the moment. For this reason, some of the functions are also untested.
Use the [master branch](https://github.com/shred/acme4j/tree/master) for production purposes. Use the [master branch](https://github.com/shred/acme4j/tree/master) for production purposes.
Known issues: Known issues:
* Documentation is incomplete and partially outdated * Documentation is incomplete and partially outdated
* The API is subject to change * The API is still subject to change
* The example is not functional at the moment * The example is not functional at the moment
* Integration tests do not fully cover all functions * Integration tests do not fully cover all functions