diff --git a/README.md b/README.md index 3d73bd8..84b5ba8 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,15 @@ A greenlock manager is just a set of a few callbacks to keeps track of: - `renewAt` (ex: '45d') - `challenges` (plugins for 'http-01', 'dns-01', etc) -The callbacks are: +The **callbacks** are: - `set({ subject, altnames, renewAt })` to save site details - `find({ subject, altnames, renewBefore })` which returns a list of matching sites (perhaps all sites) - `remove({ subject })` which marks a site as deleted - `defaults()` which either **gets** or **sets** the global configs that apply to all sites +When do they get called? Well, whenever they need to. + # Some Terminology - `subject` refers to the **primary domain** on an SSL certificate @@ -45,6 +47,7 @@ You can start _really_ simple: just make a file that exports a `create()` functi 'use strict'; var MyManager = module.exports; + MyManager.create = function(options) { console.log('The tests will make me stronger'); return {};