From 117acf71d99da8b7cca9a8cf5411dcc34900afb4 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Fri, 12 Aug 2016 03:13:33 -0400 Subject: [PATCH] update README.md --- README.md | 3 ++- examples/README.md | 12 ++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 examples/README.md diff --git a/README.md b/README.md index 6449177..00d0de5 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,8 @@ as only one process is writing the to file system or database at a time. The main implementation detail here is `approveDomains(options, certs, cb)` for new domain certificates and potentially `agreeToTerms(opts, cb)` for new accounts. -The master takes **the same arguments** as `node-letsencrypt`, plus a few extra: +The master takes **the same arguments** as `node-letsencrypt` (`challenge`, `store`, etc), +plus a few extra (`approveDomains`... okay, just one extra): `master.js`: ```javascript diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..4c8b22c --- /dev/null +++ b/examples/README.md @@ -0,0 +1,12 @@ +letsencrypt cluster examples +------------------- + +First you need to change the email address in `examples/worker.js`. + +Then you can run the example like so: + +``` +node examples/serve.js +``` + +That will put certificates in `~/letsencrypt.test` by default.