[dist] v1.0.0

bmeck · bmeck · commit 9ef16dc3f37c · 2012-10-13T10:33:54.000-05:00
diff --git a/package.json b/package.json
@@ -2,7 +2,8 @@
   "author": "bradleymeck <bradley.meck@gmail.com>",
   "name": "understudy",
   "description": "action interceptor for dynamic extensible systems",
-  "version": "0.1.1",
+  "tags": ["buzzwords"],
+  "version": "1.0.0",
   "main": "lib/index.js",
   "dependencies": {},
   "devDependencies": {},
diff --git a/readme.md b/readme.md
@@ -4,6 +4,12 @@ A means to provide interceptors when performing actions.
 
 ## Design Considerations
 
+* Async
+
+* * error first helpers
+
+* * fail fast
+
 * Modify input not output from functions
  
 * * modification of output can lead to a function giving odd results that do not match documentation
@@ -16,19 +22,22 @@ A means to provide interceptors when performing actions.
 
 ```
 var actor = new (require('understudy').Understudy)();
-actor.before('load:plugins', function (config, next) {
+function beforeHandler(config, next) {
   // load any plugins specified via config
-  ...
+  // ...
   next();
-});
-actor.after('load:plugins', function (config, next) {
+}
+function afterHandler(config, next) {
   console.log('plugins have been loaded');
   next(config);
-});
-actor.perform('load:plugins', config, function (config, allowAfter) {
+}
+actor.before('load:plugins', beforeHandler);
+actor.after('load:plugins', afterHandler);
+actor.perform('load:plugins', config, function (err, config, allowAfter) {
   // start up app
-  ...
+  // ...
   // opt-in for `after` interceptors
+  actor.before.remove('load:plugins', beforeHandler);
   allowAfter();
 });
 ```
@@ -39,6 +48,12 @@ actor.perform('load:plugins', config, function (config, allowAfter) {
 
 `interceptor` - function to fire during action
 
+### before.remove/after.remove(action, interceptor) arguments
+
+`action` - name of the action
+
+`interceptor` - function to remove from list of action handlers 
+
 ### perform(action, ...args, done) arguments
 
 `action` - name of the action
@@ -49,11 +64,12 @@ actor.perform('load:plugins', config, function (config, allowAfter) {
 
 ### action started
 
-1. The actor will start performing an "action" with `...args` for arguments.
+1. The actor will start performing an "action" with `...args`.
 2. At the end of the arguments to the event will be added a `next` function.
+2. 1. The `next` function is used for passing state via arguments and accepts an error first argument in order to fail fast.
 3. Each before interceptors will be fired in order after the previous fires the `next` function.
 4. After all interceptors have been fired the `done` function will fire with the arguments passed to the next function and an opt-in function to allow after interceptors.
-5. If the `done` function opts in to after interceptors the after interceptors will be fired in order after the previous fires the `next` function.
+5. If the `done` function opts-in to after interceptors the after interceptors will be fired in order after the previous fires the `next` function.
 
 ## Examples
 
