From dfbb24beb3d76c15637ca413cc8804c675245e87 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 20 Apr 2018 01:48:17 -0600 Subject: [PATCH] cleanup --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 11554cd..4d58c09 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,8 @@ but also provides an updated API more congruent with draft 11. Status: Stable, Locked, Bugfix-only +See Full Documentation at + ``` 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 +## 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 + + // Accounts ACME.accounts.create(options) // returns Promise registration data @@ -162,10 +166,6 @@ ACME.certificates.create(options) // returns Promise ``` Helpers & Stuff