1 | Documentation
|
2 | =============
|
3 |
|
4 | The code is documented with [JSDuck](https://github.com/senchalabs/jsduck)
|
5 | comments.
|
6 |
|
7 | To generate documentation site, you need to install JSDuck:
|
8 |
|
9 | gem install jsduck
|
10 |
|
11 | And run the command:
|
12 |
|
13 | jsduck -o output-directory/ dataflows.js/
|
14 |
|
15 | Don't mind the warnings (JSDuck isn't aware of Node.js built-ins). |
\ | No newline at end of file |