Commits

David Hessing committed f354663

Minor cleanup.

Comments (0)

Files changed (3)

 
 ## Usage ##
 
-[Create](http://dev.iron.io/worker/languages/nodejs/#upload_your_worker) Iron Scheduler as it's own task in Iron.io. Then [schedule](http://dev.iron.io/worker/scheduling/) it to run as often as you like to check whether it should queue the tasks you configured.
+[Create](http://dev.iron.io/worker/languages/nodejs/#upload_your_worker) Iron Scheduler as its own task in Iron.io. Then [schedule](http://dev.iron.io/worker/scheduling/) it to run as often as you like to check whether it should queue the tasks you configured.
 
 ## Configuration ##
 
 Some explanation for the parameters in the scheduledTasks array:
 
 1. **name** - This value is used only by Iron Scheduler for logging out information on what it did to help you track what got queued. *Required.*
-1. **schedule** - Whenever Iron Scheduler runs it compares uses this value to decide whether or not to queue the scheduled task. This value is a regular expression that is run against the Date object UTC string. [This](http://www.debuggex.com/) page is extremely helpful in contructing regex strings that give you the matches you want. Don't forget to escape the backslashes when you put it into the JSON. *Required.*
+1. **schedule** - Whenever Iron Scheduler runs it uses this value to decide whether or not to queue the scheduled task. This value is a regular expression that is matched against the Date object UTC string. [This](http://www.debuggex.com/) page is extremely helpful in contructing regex strings that give you the matches you want. Don't forget to escape the backslashes when you put it into the JSON. *Required.*
 1. **expires** - A date UTC string specifying until when Iron Scheduler should attempt to schedule this scheduled task. *Optional.*
 1. **number** - When the schedule matches, this value specifies how many of the specified tasks to queue up. *Required.*
 1. **interval** - When the schedule matches, this value specifices how long of an interval (in seconds) there should be between each of the jobs specified by the **number** parameter. So for example, if **number** is 3 and **interval** is 20, Iron Schedule will queue three tasks, the first one with a delay of 0, the second with a delay of 20 and the third with a delay of 40. *Required.*
 1. **task** - Details of the actual task to queue. *Required.*
-  1. **code_name** - The name of the task to queue. Must match the name that's in ironio. *Required.*
-  1. **payload** OR **payloadSecret** - The payload to pass to the task that will be queued. Using **payloadSecret** will filter the entire payload from the HUD view showing runs of Iron Scheduler. It has no other effect. *Required.*
+
+    1. **code_name** - The name of the task to queue. Must match the name that's in ironio. *Required.*
+    1. **payload** OR **payloadSecret** - The payload to pass to the task that will be queued. Using **payloadSecret** will filter the entire payload from the HUD view showing runs of Iron Scheduler. It has no other effect. *Required.*
 
 
 ## Current Limitations / Future Work ##
 
 * If a scheduled task is expired Iron Scheduler currently bombs (on purpose). Not sure what the correct logic should be.
-* If *interval* is set to 0 then it is treated as 1. This means that if *number* is greater than 1, the queued tasks won't be scheduled to be perfectly concurrent.
+* If **interval** is set to 0 then it is treated as 1. This means that if **number** is greater than 1, the queued tasks won't be scheduled to be perfectly concurrent.
 * Right now each queued task is it's own API call, but the ironio API supports queueing multiple tasks in one call.
 
 ## License ##
 require('JSON');
 var fs = require('fs');
 var winston = require('winston');
-var crypto = require('crypto');
 var _ = require('underscore');
 var config = {};
 
 //load the payload values
 process.argv.forEach(function (val, index, array) {
     var payload = '';
-    if (val === '-payload') { 
+    if (val === '-payload') {
         payload = fs.readFileSync(process.argv[index + 1], 'ascii');
         _.extend(config, JSON.parse(payload));
     }
 {
   "name": "ironio_scheduler",
   "version": "0.0.1",
-  "description": "Scheduling ironio actions",
+  "description": "Scheduling ironio tasks.",
   "main": "index.js",
   "directories": {
-    "test": "test"
   },
   "dependencies": {
     "q": "~0.9.6",
     "underscore": "~1.5.1",
     "JSON": "~1.0.0"
   },
-  "devDependencies": {},
+  "devDependencies": {
+  },
   "scripts": {
     "start": "node index"
   },
     "url": "git@bitbucket.org:delemach/iron_scheduler.git"
   },
   "keywords": [
-    "ironio"
+    "ironio",
+    "iron",
+    "scheduler"
   ],
   "author": "David Hessing",
   "readmeFilename": "README.md"