From 0dc09293ea80e3ecb580470d9e9d2427da459f1c Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Mon, 15 Apr 2019 23:21:16 -0600 Subject: [PATCH] v3.0.2: update docs --- README.md | 34 ++++++++++++++++++++++++---------- package.json | 9 +++++---- 2 files changed, 29 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 32363e6..ee623e2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -# [greenlock-store-test](https://git.coolaj86.com/coolaj86/greenlock-store-test.js.git) - -| A [Root](https://rootprojects.org) Project | +# [greenlock-store-test](https://git.rootprojects.org/root/greenlock-store-test.js.git) | A [Root](https://rootprojects.org) Project The test harness you should use when writing a certificate and keypair storage strategy for [Greenlock](https://git.coolaj86.com/coolaj86/greenlock-express.js) v2.7+ (and v3). @@ -32,6 +30,29 @@ tester.test(store).then(function () { }); ``` +## Reference Implementations + +These are plugins that use the v2.7+ (v3) API, and pass this test harness, +which you should use as a model for any plugins that you create. + +* [`greenlock-store-memory`](https://git.rootprojects.org/root/greenlock-store-memory.js) +* [`greenlock-store-fs`](https://git.rootprojects.org/root/greenlock-store-fs.js) + +## Example + +See `example.js` (it works). + +## Looking for the Easy Button? + +[Contact Root](mailto:support@rootprojects.org) + +If you're looking for fast and inexpensive plugin development, +we can deliver greater value in less time than most outsouring options. +We can also work with your in-house team to give a quick, inexpensive 10x +boost to internal development success. + +We also offer commercial licenses for LTS (Long-Term Support) versions of Greenlock. + ## Overview The most generic implementation, with no special considerations or custom logic, ends up looking like this: @@ -104,10 +125,3 @@ tester.test({ ``` Note: The `DB.x.y()` is where you do your magic up to connect to a database or API or whatever and keep stuff safe. - -## Examples - -See the reference implementations (they work): - - * [`greenlock-store-memory`](https://git.coolaj86.com/coolaj86/greenlock-store-memory) - * [`greenlock-store-fs`](https://git.coolaj86.com/coolaj86/greenlock-store-fs) diff --git a/package.json b/package.json index e29e2df..399cb8f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { "name": "greenlock-store-test", - "version": "3.0.1", + "version": "3.0.2", "description": "The base set of tests for all certificate and keypair storage strategies. Any Greenlock `greenlock-store-` plugin should be able to pass these tests.", + "homepage": "https://git.rootprojects.org/root/greenlock-store-test.js", "main": "index.js", "files": ["example.js"], "dependencies": {}, @@ -13,11 +14,11 @@ }, "repository": { "type": "git", - "url": "https://git.coolaj86.com/coolaj86/greenlock-store-test.js.git" + "url": "https://git.rootprojects.org/root/greenlock-store-test.js.git" }, "keywords": [ - "Let's Encrypt", "ACME", + "Let's Encrypt", "Greenlock", "test", "certificate", @@ -26,6 +27,6 @@ "credentials", "secure" ], - "author": "AJ ONeal (https://coolaj86.com/)", + "author": "AJ ONeal (https://solderjs.com/)", "license": "MPL-2.0" }