Adding missing documentation and example config

mattlenz · Jun 29, 2016 · 63949be · 63949be
1 parent e27803c
commit 63949be
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,19 @@
 This connector uses [the npm rethinkdb package](https://www.npmjs.com/package/rethinkdb). Please have a look there for detailed options.
 
 ##Configuration Options
+```yaml
+plugins:
+  storage:
+    name: rethinkdb
+    options:
+      host: ${RETHINKDB_HOST}
+      port: ${RETHINKDB_PORT}
+      database: 'someDb'
+      defaultTable: 'someTable'
+      splitChar: '/'
+```
+
+
 ```javascript
 {
 	//The host that RethinkDb is listening on

diff --git a/example-config.yml b/example-config.yml
@@ -0,0 +1,9 @@
+plugins:
+  storage:
+    name: rethinkdb
+    options:
+      host: ${RETHINKDB_HOST}
+      port: 28015
+      database: 'someDb'
+      defaultTable: 'someTable'
+      splitChar: '/'