root
/
greenlock.js
mirror of https://github.com/therootcompany/greenlock.js.git
2
0
Fork 0
Code Issues 27 Releases Wiki Activity

rename in api

This commit is contained in:
AJ ONeal 2016-08-06 01:34:34 -04:00
parent afa10a2c63
commit 16bfac31bb
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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: