add preid to readme

stephenlacy · Mar 13, 2015 · d588ac4 · d588ac4
1 parent 7fb8a69
commit d588ac4
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -200,6 +200,18 @@ Set the amount of spaces for indentation in the result JSON file.
     Type: `Number`
     Default: Same as original source file
 
+### options.preid
+Set the prerelase tag to use
+
+    Type: `String`
+    Default: `null`
+
+Example:
+
+```js
+bump({type: 'prerelease', preid : 'alphaWhateverTheYWant'});
+ // => '0.0.2-alphaWhateverTheYWant.0'
+```
 
 ## Versioning
 #### Versioning Used: [Semantic](http://semver.org/)