Permalink
Browse files

more react to autoflow changes

  • Loading branch information...
1 parent 6872794 commit 0e41d3d2e7724621f24f92d8dde7ced7ada7e116 @jeffbski committed Dec 15, 2013
Showing with 22 additions and 20 deletions.
  1. +15 −13 README.md
  2. +3 −3 doc/advanced.md
  3. +4 −4 package.json
View
@@ -1,6 +1,6 @@
# autoflow.js
-[![Build Status](https://secure.travis-ci.org/jeffbski/react.png?branch=master)](http://travis-ci.org/jeffbski/react)
+[![Build Status](https://secure.travis-ci.org/jeffbski/autoflow.png?branch=master)](http://travis-ci.org/jeffbski/autoflow)
autoflow (formerly named react) is a javascript module to make it easier to work with asynchronous code, by reducing boilerplate code and improving error and exception handling while allowing variable and task dependencies when defining flow. This project is applying the concepts of Reactive programming or Dataflow to controlling application flow.
@@ -46,7 +46,7 @@ You can read more and see his example site here https://github.com/ryanatkn/reac
- class method calls
- selectFirst flow where the first task that returns defined, non-null value is used
- promise style functions - also automatic resolution of promise inputs (optionally loaded with `autoflow.resolvePromises();`)
- - use of resulting flow function as callback style or promise style (if no callback provided) (provided via plugin corresponding to the promise library used) See https://github.com/jeffbski/react-deferred and https://github.com/jeffbski/react-q
+ - use of resulting flow function as callback style or promise style (if no callback provided) (provided via plugin corresponding to the promise library used) See https://github.com/jeffbski/autoflow-deferred and https://github.com/jeffbski/autoflow-q
- supports ES5 browsers (can work with others by using polyfills)
- (planned) iteration on arrays, streams, sockets
- (planned) event emitter integration
@@ -80,7 +80,7 @@ To Reduce the boilerplate code needed and improve error handling, autoflow autom
OR
-Pull from github - http://github.com/jeffbski/react
+Pull from github - http://github.com/jeffbski/autoflow
## Examples
@@ -141,10 +141,10 @@ foobar.loadRender('foo.txt', 'bar.txt', 'BBB', function (err, renderedOut) {
Below is a graph of how the dependencies are mapped by autoflow which
Also Indicates how the tasks will be executed. This was generated by the
-autoflow plugin [react-graphviz](https://github.com/jeffbski/react-graphviz)
+autoflow plugin [autoflow-graphviz](https://github.com/jeffbski/autoflow-graphviz)
which you can use to also graph your flows.
-![simple.png](https://github.com/jeffbski/react/raw/master/doc/simple.png)
+![simple.png](https://github.com/jeffbski/autoflow/raw/master/doc/simple.png)
@@ -162,7 +162,9 @@ var fn = autoflow('loadRender', 'fooPath, barPath, barP2, cb -> err, renderedOut
);
```
-![color-def](https://github.com/jeffbski/react/raw/master/doc/color-def.png)
+![color-def](https://github.com/jeffbski/autoflow/raw/master/doc/color-def.png)
+
+Note: graphic uses the old name `react`, new name is `autoflow`
1. **flow/function name** - string - represents the name of the flow or function that will be created. autoflow will use the name when generating events so you can monitor progress and performance and also when errors occur.
2. **In/out flow parameter definition** - string - the inputs and outputs for the flow function. The parameters are specified in one single string for easy typing, separated by commas. The output follows the input after being separated by a `->`. Use the parameter name `cb` or `callback` to specify the Node style callback and `err` to represent the error parameter as the first output parameter of the callback. Literal values can also be specified directly (true, false, numbers, this, null). Literal strings can simply be quoted using single or double quotes.
@@ -179,18 +181,18 @@ The Flow function created by autoflow from the input definition is a normal Node
### Debugging autoflow
-autoflow has a built-in plugin which can be loaded that will enable logging of tasks and flow as it executes very useful for debugging. For full details see [Advanced autoflow - LogEvents](https://github.com/jeffbski/react/blob/master/doc/advanced.md#LogEvents) along with the other plugins and an explanation of the AST autoflow uses.
+autoflow has a built-in plugin which can be loaded that will enable logging of tasks and flow as it executes very useful for debugging. For full details see [Advanced autoflow - LogEvents](https://github.com/jeffbski/autoflow/blob/master/doc/advanced.md#LogEvents) along with the other plugins and an explanation of the AST autoflow uses.
```Javascript
var autoflow = require('autoflow');
-react.logEvents(); // turn on flow and task logging for all autoflow functions
+autoflow.logEvents(); // turn on flow and task logging for all autoflow functions
```
### Advanced autoflow
autoflow has many additional plugins and features which enable logging, monitoring, promise resolution, etc.
-See The [Advanced autoflow](https://github.com/jeffbski/react/blob/master/doc/advanced.md) for details on the AST autoflow uses for processing and other plugins that are available.
+See The [Advanced autoflow](https://github.com/jeffbski/autoflow/blob/master/doc/advanced.md) for details on the AST autoflow uses for processing and other plugins that are available.
@@ -216,7 +218,7 @@ See The [Advanced autoflow](https://github.com/jeffbski/react/blob/master/doc/ad
## Test Results
-[![Build Status](https://secure.travis-ci.org/jeffbski/react.png?branch=master)](http://travis-ci.org/jeffbski/react)
+[![Build Status](https://secure.travis-ci.org/jeffbski/autoflow.png?branch=master)](http://travis-ci.org/jeffbski/autoflow)
```bash
mocha
@@ -226,15 +228,15 @@ mocha
## License
- - [MIT license](http://github.com/jeffbski/react/raw/master/LICENSE)
+ - [MIT license](http://github.com/jeffbski/autoflow/raw/master/LICENSE)
## Contributors
- Author: Jeff Barczewski (@jeffbski)
## Contributing
- - Source code repository: http://github.com/jeffbski/react
- - Ideas and pull requests are encouraged - http://github.com/jeffbski/react/issues
+ - Source code repository: http://github.com/jeffbski/autoflow
+ - Ideas and pull requests are encouraged - http://github.com/jeffbski/autoflow/issues
- You may contact me at @jeffbski or through github at http://github.com/jeffbski
View
@@ -121,7 +121,7 @@ Available Events that can be logged:
### Automatic Promise Resolution for inputs
-If you want to automatically resolve promises in autoflow without having to manually call `when` or `then`, autoflow provides a plugin which will detect the existence of a `then` method (indicating a promise) at runtime from any inputs to the flow and will internally create `when` tasks to resolve them before passing the values to other tasks. This built-in plugin is not loaded normally but is loaded by invoking the autoflow method `resolvePromises`. External plugins like `react-deferred` and `react-q` also enable this but also provide additional promise integration. See https://github.com/jeffbski/react-deferred and https://github.com/jeffbski/react-q
+If you want to automatically resolve promises in autoflow without having to manually call `when` or `then`, autoflow provides a plugin which will detect the existence of a `then` method (indicating a promise) at runtime from any inputs to the flow and will internally create `when` tasks to resolve them before passing the values to other tasks. This built-in plugin is not loaded normally but is loaded by invoking the autoflow method `resolvePromises`. External plugins like `autoflow-deferred` and `autoflow-q` also enable this but also provide additional promise integration. See https://github.com/jeffbski/autoflow-deferred and https://github.com/jeffbski/autoflow-q
```Javascript
var autoflow = require('autoflow');
@@ -171,5 +171,5 @@ collector.clear(); // clear the list of events;
### External Plugins
- - https://github.com/jeffbski/react-deferred - integrates jQuery style Deferred/Promises with autoflow, providing automatic promise resolution and optional usage for autoflow functions where by calling without a callback returns a promise.
- - https://github.com/jeffbski/react-q - integrates Q-style Deferred/Promises with autoflow, providing automatic promise resolution and optional usage for autoflow functions where by calling without a callback returns a promise.
+ - https://github.com/jeffbski/autoflow-deferred - integrates jQuery style Deferred/Promises with autoflow, providing automatic promise resolution and optional usage for autoflow functions where by calling without a callback returns a promise.
+ - https://github.com/jeffbski/autoflow-q - integrates Q-style Deferred/Promises with autoflow, providing automatic promise resolution and optional usage for autoflow functions where by calling without a callback returns a promise.
View
@@ -1,11 +1,11 @@
{
"name": "autoflow",
"description": "Autoflow (formerly named react) is a javascript module implementing a control-flow / flow control engine to make it easier to work with asynchronous code, by reducing boilerplate code and improving error and exception handling while allowing variable and task dependencies when defining flow.",
- "version": "0.7.1",
+ "version": "0.7.2",
"author": "Jeff Barczewski <jeff.barczewski@gmail.com>",
- "repository": { "type": "git", "url": "http://github.com/jeffbski/react.git" },
- "bugs" : { "url": "http://github.com/jeffbski/react/issues" },
- "licenses": [{ "type": "MIT", "url" : "http://github.com/jeffbski/react/raw/master/LICENSE" }],
+ "repository": { "type": "git", "url": "http://github.com/jeffbski/autoflow.git" },
+ "bugs" : { "url": "http://github.com/jeffbski/autoflow/issues" },
+ "licenses": [{ "type": "MIT", "url" : "http://github.com/jeffbski/autoflow/raw/master/LICENSE" }],
"main": "lib/autoflow",
"engines": { "node": ">=0.6" },
"dependencies": {

0 comments on commit 0e41d3d

Please sign in to comment.