coz/doc/guides/02-howto.md.hbs

Getting started
------

### Requirements

+ [node.js][nodejs_url]


### Installation

{{pkg.name}} is available as an [npm][npm_url] package.

```bash
# Install {{pkg.name}} as a global module.
$ npm install {{pkg.name}} -g
```

Or you can install it without `-g` option and use [Programmatic API](#programmatic-api).
For more details, see tutorial section "[01 - Installing coz][01_installing_coz_url]".


### Quickstart

**.who-likes-what.txt.bud** (bud file)
```javascript
{{{read './example/01-minimum-demo/.who-likes-what.txt.bud'}}}
```

As you see, `.bud` file is actuary a JavaScript file and could be exported a Node.js module.

Save this file as `.who-likes-what.txt.bud` and then, run:

```bash
# Render the bud file
$ coz render ".who-likes-what.txt.bud"
```

This will generate a file named `who-likes-what.txt`.

For more details, see tutorial section "[02 - Rendering bud files][02_rendering_bud_files_url]".


<a name="programmatic-api" />
### Programmatic API

{{pkg.name}} provides programmatic API which enables you to execute {{pkg.name}} commands from Node.js program.

```javascript
{{{read './example/04-from-programmatic-api/run_rendering.js'}}}
```

For more details, see tutorial section "[04 - Using programmatic API][04_using_programmatic_a_p_i_url]".


[nodejs_url]: https://nodejs.org/en/
[npm_url]: https://www.npmjs.com/