| 1 | Getting started
|
| 2 | ------
|
| 3 |
|
| 4 | ### Requirements
|
| 5 |
|
| 6 | + [node.js{{pkg.engines.node}}][nodejs_url]
|
| 7 |
|
| 8 | ### Installation
|
| 9 |
|
| 10 | {{pkg.name}} is available as an [npm][npm_url] package.
|
| 11 |
|
| 12 | ```bash
|
| 13 | # Install {{pkg.name}} as a global module.
|
| 14 | $ npm install {{pkg.name}} -g
|
| 15 | ```
|
| 16 |
|
| 17 | Or you can install it without `-g` option and use [Programmatic API](#programmatic-api).
|
| 18 |
|
| 19 |
|
| 20 | <a name="available commands"/>
|
| 21 |
|
| 22 | ### Available Commands
|
| 23 |
|
| 24 | ```bash
|
| 25 | $ fur -h
|
| 26 | {{{vars.usages.all}}}
|
| 27 | ```
|
| 28 |
|
| 29 | <a name="programmatic-api"/>
|
| 30 |
|
| 31 | ### Programmatic API
|
| 32 |
|
| 33 | {{pkg.name}} provides programmatic API which enables you to execute {{pkg.name}} commands from Node.js program.
|
| 34 |
|
| 35 | ```javascript
|
| 36 | {{{render 'example/example-api.js'}}}
|
| 37 | ```
|
| 38 |
|
| 39 |
|
| 40 | [nodejs_url]: https://nodejs.org/
|
| 41 | [npm_url]: https://www.npmjs.com
|
| 42 | |
| \ | No newline at end of file |