add API brief

This commit is contained in:
AJ ONeal 2016-08-12 15:21:35 -06:00
parent f8f7a75c99
commit e120d2dcc2
1 changed files with 17 additions and 0 deletions

View File

@ -5,3 +5,20 @@ The reference implementation, specification, template, and tests for creating an
The reference implementation is completely in-memory.
See [Help Wanted: Database Plugins (for saving certs)](https://github.com/Daplie/node-letsencrypt/issues/39)
API
===
```
* getOptions()
* accounts.
* checkKeypair(opts, cb)
* setKeypair(opts, keypair, cb)
* check(opts, cb)
* set(opts, reg, cb)
* certificates.
* checkKeypair(opts, cb)
* setKeypair(opts, keypair, cb)
* check(opts, cb)
* set(opts, reg, cb)
```