Version Bump and README update

Author: GochoMugo

README.md

@@ -10,10 +10,11 @@ sequential and human-readable ids.
 
 |aspect|detail|
 |-------|-----:|
-|version|0.0.0-alpha.4.2|
+|version|0.0.0-alpha.5.0|
 |dependencies|none|
 |node|0.11, 0.10|
-|last updated|6th Oct, 2014|
+|last updated|24th Oct, 2014|
+
 
 ## installation
 
@@ -23,6 +24,7 @@ From [Npm][npmjs]:
 $ npm install sequential-ids --save
 ```
 
+
 ## usage
 
 ```js
@@ -67,6 +69,7 @@ accessor.next('otherKey',function(err, id) {
 });
 ```
 
+
 ## notes
 
 1. **new Generator([options])**
@@ -81,7 +84,9 @@ accessor.next('otherKey',function(err, id) {
     * and, additionally, the same attributes as the Generator#add
     **options** object
 
-  * in a case where you may require more than one generator, you would allocate them to different ports. See ahead on how to target each of the different generators.
+  * in a case where you may require more than one generator, you
+    would allocate them to different ports. See ahead on how to target
+    each of the different generators.
 
   ```js
   var sequential = require("sequential-ids");
@@ -92,10 +97,12 @@ accessor.next('otherKey',function(err, id) {
   * A generator has the following methods:
 
     * `Generator#start()`
-      * starts the generator. If no Error is thrown, the generator will be ready for Accessors.
+      * starts the generator. If no Error is thrown, the generator will be
+        ready for Accessors.
 
     * `Generator#add(key, [options])`
-      * adds a new key to the generator. If no Error is thrown, the generator will be ready for Accessors.
+      * adds a new key to the generator. If no Error is thrown, the
+        generator will be ready for Accessors.
       * returns `false` if `key` had already been added to the
         generator; otherwise, returns `true`
 
@@ -111,22 +118,35 @@ accessor.next('otherKey',function(err, id) {
             * assigning `0` (zero) lets you ignore the letters part
             * Defaults to `3`.
         * `store`:
-            * a function that will be called to store the IDs on disk for persistence.
-            * the function is passed an array of IDs that have been generated.
-            * repeatedly storing the last ID is useful to know where to start from in the next session.
+            * a function that will be called to store the IDs on disk for
+              persistence.
+            * the function is passed an array of IDs that have been
+              generated.
+            * repeatedly storing the last ID is useful to know where to
+              start from in the next session.
             * Defaults to `null`.
-        * `store\_freq`:
+        * `store_freq`:
             * frequency at which the store function should be called.
             * Defaults to `1`(called every 1 ID is generated)
         * `restore`:
             * last ID that was generated.
             * IDs will be generated from here on.
-            * `digits` and `letters` will be ignored so as to follow the restore ID style.
-            * it **must** be in the same style as IDs generated by the Generator
+            * `digits` and `letters` will be ignored so as to follow the
+              restore ID style.
+            * it **must** be in the same style as IDs generated by the
+              Generator
             * If not specified, generates from start.
             * **MUST** be a string.
             * Overides the `.digits` and `.letters` options.
             * Defaults to `null`.
+        * `autoAddKeys`:
+            * whether to automatically add keys when IDs are requested
+              with a non-existent key.
+            * If `true`, such a key is added and an ID returned as though
+              the key was already added using the Generator's options.
+            * If `false`, an Error is passed to callback, if any, or `null` is
+              returned.
+            * Defaults to `false`.
 
     * `Generator#generate(key)`
       * generates a new ID for **key**. If no **key** is given, uses
@@ -140,12 +160,14 @@ accessor.next('otherKey',function(err, id) {
     * `Generator#stop()`
       * stops the generator. No more IDs will be given to Accessors.
 
-
 2. **new Accessor([port])**
 
   * used to access IDs.
-  * **port** is the port number of your generator. In case where, you did not specify a port when creating a Generator instance, you may leave this out. Defaults to `9876`.
-  * an accessor may be initialized in a separate file. Ensure you got the port numbers correct.
+  * **port** is the port number of your generator. In case where, you
+    did not specify a port when creating a Generator instance, you may
+    leave this out. Defaults to `9876`.
+  * an accessor may be initialized in a separate file. Ensure you got the
+    port numbers correct.
   * an accessor has the following methods:
 
     * `Accessor#next(key,callback)`:
@@ -167,9 +189,12 @@ accessor.next('otherKey',function(err, id) {
 
 * Robust Error handling
 * Implement these features:
-    * `session(callback)` - passes the number of IDs generated in the session.
+    * `session(callback)` - passes the number of IDs generated in the
+      session.
     * `.used(callback)` - passes the total number of IDs generated.
-    * `.semantics(callback)` - passes the remaining no. of IDs to be generated before breaking our semantics specified while creating the generator.
+    * `.semantics(callback)` - passes the remaining no. of IDs to be
+      generated before breaking our semantics specified while creating
+      the generator.
 
 
 ## contribution
@@ -178,11 +203,18 @@ accessor.next('otherKey',function(err, id) {
 * Pull requests be accompanied with tests as in the `/tests` directory
 * Issues may be filed [here][issues]
 
+A list of contributors:
+
+1. [GochoMugo](https://github.com/GochoMugo)
+*  [André Santos](https://github.com/andrefs)
+
+
 ## license
 
 Copyright (c) 2014 Forfuture LLC
 
-Sequential Ids and its source code are licensed under the [MIT][mit] license. See [LICENSE](LICENSE) file accompanying this text.
+Sequential Ids and its source code are licensed under the [MIT][mit]
+  license. See [LICENSE](LICENSE) file accompanying this text.
 
 
 [issues]:https://github.com/forfuture-dev/node-sequential-ids/issues

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sequential-ids",
-  "version": "0.0.0-alpha.4.2",
+  "version": "0.0.0-alpha.5.0",
   "description": "centralized generation of sequential, human-readable ids",
   "homepage": "https://github.com/forfuture-dev/node-sequential-ids",
   "license": "MIT",