[Prerelease] Bumped version number

Author: iolufemi

CHANGELOG.md

@@ -1,3 +1,8 @@
+<a name="0.6.0"></a>
+# [0.6.0](https://github.com/EnsembleLab/api-template/compare/0.5.0...0.6.0) (2019-02-10)
+
+
+
 <a name="0.5.0"></a>
 # [0.5.0](https://github.com/EnsembleLab/api-template/compare/0.4.1...0.5.0) (2018-05-02)
 

README.md

@@ -104,6 +104,37 @@ You will now be able to access CRUD (create, read, update and delete) endpoints
 
 > Note: For every `POST` API calls you need to send an `x-tag` value in the header. This value is used for secure communication between the server and client. It is used for AES encrytion when secure mode is enabled. To get a valid `x-tag` call the `[GET] /initialize` endpoint.   
 
+## Some asynchronous goodness
+
+Start the clock (You should only have a single instance of this at all times.)
+
+```
+$ npm run clock
+```
+The clock is similar to a crontab. It dispatches tasks to available workers at a predefined interval.
+
+To define a clock, look for the `clock` collection in the MongoDB you connected to the `LOG_MONGOLAB_URL` environment variable, and create a record similar to the below
+
+```json
+{ 
+    "crontab" : "* * * * *", 
+    "name" : "Task Name", 
+    "job" : "theJobAsDefinedInTheWorkerFile", 
+    "enabled" : true
+}
+```
+
+> NOTE: Whenever you change the value of a clock on the DB, you need to restart the clock. (Still looking for the best way to make this automatic)
+
+Start the workers 
+
+```
+$ npm run workers
+```
+A worker runs tasks or processes in the background. It is useful for running long running processes and background tasks.
+
+See `/services/queue/jobs` for sample tasks and `/services/queue/workers` for how to setup worker processes.
+
 ## Versioning your API endpoints
 
 You can create multiple versions of your API endpoints by simply adding the version number to your route file name. eg. `users.v1.js` will put a version of the users resources on the `/v1/users` endpoint. users.v2.js will put a version of the users resources on the `/v2/users` endpoint. The latest version of the resources will always be available at the `/users` endpoint.

TODO.md

@@ -3,7 +3,6 @@
 |:------|:------:|:------
 | app.js | 61 | Write a complete Documentation for this project
 | config/index.js | 12 | Test for production and development senarios
-| models/index.js | 14 | Automatically generate tests with the schema structure
 | routes/index.js | 260 | Test API versioning
 | routes/index.js | 261 | Test rate limiting
 | routes/index.js | 262 | Test complete route Loader test
@@ -12,5 +11,6 @@
 | routes/index.js | 265 | Make Log requests testable and write unit tests for it
 | routes/index.js | 266 | Develop the route loader into a separate node module to be publish on npm
 | routes/index.js | 267 | Develop all services onto separate node module to be publish on npm
+| models/index.js | 14 | Automatically generate tests with the schema structure
 | services/logger/index.js | 48 | Test Error Handler
 | services/request/index.js | 90 | Test request module

package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-template",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "A template for creating APIs Fast",
   "main": "app.js",
   "scripts": {