readme options

senecajs · Jun 3, 2020 · 8bf5b48 · 8bf5b48
1 parent b0a330d
commit 8bf5b48
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -103,6 +103,31 @@ examples of the generated output, run on the _seneca-doc_ plugin
 itself.
 
 
+<!--START:options-->
+
+
+## Options
+
+* `test` : boolean <i><small>false</small></i>
+
+
+Set plugin options when loading with:
+```js
+
+
+seneca.use('doc', { name: value, ... })
+
+
+```
+
+
+<small>Note: <code>foo.bar</code> in the list above means 
+<code>{ foo: { bar: ... } }</code></small> 
+
+
+
+<!--END:options-->
+
 
 <!--START:action-list-->