Skip to content

Commit

Permalink
small edits to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bjouhier committed Nov 16, 2011
1 parent ff558a2 commit 1db94f3
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Expand Up @@ -34,18 +34,20 @@ Streamline also provides _futures_, and comes with a small optional library of h
# Generation options

Streamline gives you the choice between generating regular callback-based asynchronous code,
or generating code that takes advantage of the fibers library.
or generating code that takes advantage of the [fibers library](https://github.com/laverdet/node-fibers).

The _callback_ option produces code that does not have any special runtime dependencies. You may even use it
to generate asynchronous code for the browser.

The _fibers_ option produces simpler code but requires that you install
the [fibers library](https://github.com/laverdet/node-fibers) (easy: `npm install fibers`).
the fibers library (easy: `npm install fibers`).
This option gives superior development experience: line numbers are always preserved in the transformed code;
you can step with the debugger through asynchronous calls without having to go through complex callbacks, etc.
It may also generate more efficient code (to be confirmed by benchmarks).

The fibers option can be activated by passing `--fibers` to the `node-streamline` command or by setting the `fibers` option when registering streamline (see `streamline/lib/compiler/register.register`)
The fibers option can be activated by passing `--fibers` to the `node-streamline` command or by
setting the `fibers` option when registering streamline
(see the `register(options)` function in `streamline/lib/compiler/register`).

# On-line demo

Expand Down

0 comments on commit 1db94f3

Please sign in to comment.