add not notation doc

stephenlacy · Feb 23, 2015 · 88547e2 · 88547e2
1 parent d33a1d2
commit 88547e2
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -166,6 +166,20 @@ Example:
 .pipe(bump({key: 'build-version'}))
 .pipe(bump({key: 'dev-version', type: 'major'}))
 ```
+##### Dot notation is supported for nested versions:
+
+```js
+
+.pipe(bump({key: {'sublevel.version'}}))
+
+/*
+{
+  "sublevel": {
+    "version": "<semver>"
+  }
+}
+*/
+```
 
 ### options.version
 Set a specific version to bump to.