From 16bfac31bb0f1cab93f263ce46772af1e335d100 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Sat, 6 Aug 2016 01:34:34 -0400 Subject: [PATCH] rename in api --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ec547c..43ef29c 100644 --- a/README.md +++ b/README.md @@ -148,7 +148,7 @@ le = LE.create({ // Check in-memory cache of certificates for the named domain -le.exists({ domain: 'example.com' }).then(function (results) { +le.check({ domain: 'example.com' }).then(function (results) { if (results) { // we already have certificates return; @@ -156,11 +156,11 @@ le.exists({ domain: 'example.com' }).then(function (results) { // Register Certificate manually - le.register({ + le.get({ domains: ['example.com'] // CHANGE TO YOUR DOMAIN (list for SANS) , email: 'user@email.com' // CHANGE TO YOUR EMAIL - , agreeTos: '' // set to tosUrl string to pre-approve (and skip agreeToTerms) + , agreeTos: '' // set to tosUrl string (or true) to pre-approve (and skip agreeToTerms) , rsaKeySize: 2048 // 2048 or higher , challengeType: 'http-01' // http-01, tls-sni-01, or dns-01 @@ -199,6 +199,12 @@ API The full end-user API is exposed in the example above and includes all relevant options. +``` +le.register +le.get // checkAndRegister +le.check +``` + ### Helper Functions We do expose a few helper functions: