From 58f46f5d9664013995f9be8f9f959cec84d434a3 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Sat, 12 Dec 2015 22:16:02 +0000 Subject: [PATCH] updates --- README.md | 29 +++++++++++++++++++++++++---- {bin => examples}/standalone.js | 0 2 files changed, 25 insertions(+), 4 deletions(-) rename {bin => examples}/standalone.js (100%) diff --git a/README.md b/README.md index a2d09f1..bc57c6b 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,36 @@ pushd letsencrypt ./letsencrypt-auto ``` +Usage Examples +======== + +Here's a small snippet: + +``` +le.register({ + domains: ['example.com', 'www.example.com'] +, email: 'user@example.com' +, agreeTos: true +}, function (err, certs) { + // do stuff +}); +``` + +**However**, due to the nature of what this library does, it has a few more "moving parts" +than what makes since to show in a minimal snippet. + +* [commandline (standalone with "webroot")](https://github.com/Daplie/node-letsencrypt/blob/master/examples/commandline.js) +* [expressjs (fully automatic https)](https://github.com/Daplie/node-letsencrypt/blob/master/examples/express.js) + See Also ======== -* [Examples](https://github.com/Daplie/node-letsencrypt/tree/master/examples) +* See [Examples](https://github.com/Daplie/node-letsencrypt/tree/master/examples) * [Let's Encrypt in (exactly) 90 seconds with Caddy](https://daplie.com/articles/lets-encrypt-in-literally-90-seconds/) * [lego](https://github.com/xenolf/lego): Let's Encrypt for golang -Usage -===== +API +=== * `LetsEncrypt.create(backend, bkDefaults, handlers)` * `le.middleware()` @@ -47,7 +68,7 @@ Usage * `le.fetch({domains, email, agreeTos, ... }, cb)` * `le.validate(domains, cb)` -### `LetsEncrypt.create(backend, bkDefaults, handlers);` +### `LetsEncrypt.create(backend, bkDefaults, handlers)` #### backend diff --git a/bin/standalone.js b/examples/standalone.js similarity index 100% rename from bin/standalone.js rename to examples/standalone.js