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