From b163b3345584f0087546764cd6804b8092e0dc54 Mon Sep 17 00:00:00 2001
From: AJ ONeal <coolaj86@gmail.com>
Date: Sat, 6 Apr 2019 14:05:54 -0600
Subject: [PATCH] v3.0.1: doc updates

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d9160ed..76e018c 100644
--- a/README.md
+++ b/README.md
@@ -16,9 +16,43 @@ npm install --save-dev le-manage-test@3.x
 
 ## Usage
 
-```bash
+```js
 var tester = require('le-manage-test');
 
+tester.test({
+  set: function updateDomains(info) {
+    // { subject: 'example.com'
+    // , altnames: ['example.com', '*.example.com', 'foo.bar.example.com' ] }
+    DB.set(...)
+    return null;
+  }
+, get: function approveDomains(query) {
+    // { domain: 'www.example.com'
+    // , wildname: '*.example.com' // (for convenience, if you need it)
+    return DB.get(...).then(function () {
+      // { subject: 'example.com', altnames: [...] }
+      return info;
+    });
+  }
+}).then(function () {
+  console.info("PASS");
+});
+```
+
+Note: The management plugin and storage plugins must support wildcards,
+but if the user can't select or implement a dns-01 challenge then that
+user simply doesn't get to use them. No worries. Nothing breaks.
+
+## Overview
+
+Here's a more expanded breakdown of what the implementations might look like
+(if that was too terse above):
+
+```js
+var tester = require('le-manage-test');
+```
+
+```js
 // The function that checks the database for the domain (or its wildcard) and returns the results
 function approveDomains(opts) {
   var domain = opts.domain;
@@ -35,12 +69,16 @@ function approveDomains(opts) {
   //return { subject: 'example.com', altnames: [ 'example.com', 'www.example.com' ] };
   return { subject: info.subject, altnames: info.altnames };
 }
+```
 
+```js
 function updateDomains(opts) {
   // return null (not undefined)
   return DB.associate(opts.subject, opts.altnames);
 }
+```
 
+```js
 tester.test({
   set: updateDomains
 , get: approveDomains