From baa35c2f9374ca9ca3f42bb3c888890c5ef5fe3a Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Mon, 15 Apr 2019 22:50:02 -0600 Subject: [PATCH] v3.0.2: update docs --- README.md | 24 +++++++++++++++--------- package.json | 7 ++++--- 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e63ea18..43e91c2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -# [greenlock-challenge-test](https://git.coolaj86.com/coolaj86/greenlock-challenge-test.js.git) - -| A [Root](https://rootprojects.org) Project | +# [greenlock-challenge-test](https://git.rootprojects.org/root/greenlock-challenge-test.js.git) | A [Root](https://rootprojects.org) Project The test harness you should use when writing an ACME challenge strategy for [Greenlock](https://git.coolaj86.com/coolaj86/greenlock-express.js) v2.7+ (and v3). @@ -35,8 +33,22 @@ tester.test('http-01', domain, challenger).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-challenge-http](https://git.rootprojects.org/root/greenlock-challenge-http.js) +* [greenlock-challenge-dns](https://git.rootprojects.org/root/greenlock-challenge-dns.js) + +## Example + +See `example.js` (it works). + ## Overview +Here's a quick pseudo stub-out of what a test-passing plugin object might look like: + ```js tester.test('http-01', 'example.com', { set: function (opts) { @@ -84,9 +96,3 @@ tester.test('http-01', 'example.com', { Note: The `API.get()`, `API.set()`, and `API.remove()` is where you do your magic up to upload a file to the correct location on an http serever, set DNS records, or add the appropriate data to the database that handles such things. - -## Example - -See `example.js` (it works). - -Will post reference implementations here later... diff --git a/package.json b/package.json index 917fbbe..b73e0e6 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,9 @@ { "name": "greenlock-challenge-test", - "version": "3.0.1", + "version": "3.0.2", "description": "The base set of tests for all ACME challenge strategies. Any `greenlock-challenge-` plugin should be able to pass these tests.", "main": "index.js", + "homepage": "https://git.rootprojects.org/root/greenlock-challenge-test.js", "dependencies": {}, "devDependencies": {}, "scripts": { @@ -10,7 +11,7 @@ }, "repository": { "type": "git", - "url": "https://git.coolaj86.com/coolaj86/greenlock-challenge-test.js.git" + "url": "https://git.rootprojects.org/root/greenlock-challenge-test.js.git" }, "keywords": [ "Let's Encrypt", @@ -22,6 +23,6 @@ "module", "strategy" ], - "author": "AJ ONeal (https://coolaj86.com/)", + "author": "AJ ONeal (https://solderjs.com/)", "license": "MPL-2.0" }