coolaj86/acme.js
1
0
Fork 0
mirror of https://github.com/therootcompany/acme.js.git synced 2024-11-16 17:29:00 +00:00
Code Issues 1 Projects Releases Wiki Activity

cleanup

Browse Source
This commit is contained in:
AJ ONeal 2018-04-20 01:48:17 -06:00
parent 5b254d7fd9
commit dfbb24beb3
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -94,6 +94,8 @@ but also provides an updated API more congruent with draft 11.
Status: Stable, Locked, Bugfix-only
See Full Documentation at <https://git.coolaj86.com/coolaj86/le-acme-core.js>
```
var RSA = require('rsa-compat').RSA;
var acme = require('acme-v2/compat.js').ACME.create({ RSA: RSA });
@ -103,16 +105,15 @@ var acme = require('acme-v2/compat.js').ACME.create({ RSA: RSA });
//
```
See documentation at <https://git.coolaj86.com/coolaj86/le-acme-core.js>
## Promise API (dev)
## draft API (dev)
Status: Almost stable, not locked
Status: Almost stable, but **not semver locked**
This API is a simple evolution of le-acme-core,
but tries to provide a better mapping to the new draft 11 APIs.
```
// Create Instance (Dependency Injection)
var ACME = require('acme-v2').ACME.create({
RSA: require('rsa-compat').RSA
@ -131,9 +132,12 @@ var ACME = require('acme-v2').ACME.create({
// don't try to validate challenges locally
, skipChallengeTest: false
});
```
```javascript
// Discover Directory URLs
ACME.init(acmeDirectoryUrl) // returns Promise<acmeUrls={keyChange,meta,newAccount,newNonce,newOrder,revokeCert}>
// Accounts
ACME.accounts.create(options) // returns Promise<regr> registration data
@ -162,10 +166,6 @@ ACME.certificates.create(options) // returns Promise<pems={ privkey
, setChallenge: fn (hostname, key, val) // return Promise
, removeChallenge: fn (hostname, key) // return Promise
}
// Discovery URLs
ACME.init(acmeDirectoryUrl) // returns Promise<acmeUrls={keyChange,meta,newAccount,newNonce,newOrder,revokeCert}>
```
Helpers & Stuff