diff --git a/README.md b/README.md index d257b6f..bce2826 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,39 @@ The reference implementation is completely in-memory. See [Help Wanted: Database Plugins (for saving certs)](https://github.com/Daplie/node-letsencrypt/issues/39) +How to create a custom strategy +=============================== + +Let's say there's some new database AwesomeDB that +we want to make a plugin for, here's how we'd start: + +```bash +# First create you repo on github or wherever +# Then clone it +git clone git@github.com:AwesomeDB/le-store-awesome.git + +pushd le-store-awesome + +git pull https://github.com/Daplie/le-store-SPEC.git template + +git push +``` + +Or, if you already have some code and just need to merge in the tests: + +```bash +git pull https://github.com/Daplie/le-store-SPEC.git tests +``` + +Next, Just run the tests + +``` +node tests/basic.js +``` + +Note: you should not modify the tests that come from the tests branch, +but rather create separate files for your own tests. + API ===