Skip to content

Commit

Permalink
README show API right. #2
Browse files Browse the repository at this point in the history
  • Loading branch information
lepture committed May 8, 2013
1 parent 1561819 commit e3588b2
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions README.md
Expand Up @@ -87,7 +87,7 @@ var sections = ganam(code);
```


### style
### style(filepath [, options], callback)

Ganam style a file:

Expand All @@ -108,7 +108,9 @@ A **styleguide** is something like:
}
```

### styleSync
You can pass options for `stylus`.

### styleSync(filepath [, options])

Ganam style a file synchronously:

Expand All @@ -117,16 +119,8 @@ var ganam = require('ganam');
var styleguide = ganam.styleSync('./bar.styl');
```

## Nico

We have a live example for you: [styleguide](http://lab.lepture.com/ganam/guide/buttons).
The code of this styleguide is located at: [ganam/docs/guide](https://github.com/lepture/ganam/blob/master/docs/guide).
This styleguide is built with [nico](http://lab.lepture.com/nico/).

Find more information about nico and get nico with:
## Ganam CLI

```
$ npm install nico -g
```
The missing command line tools is not ready now.

Have a look at the config file [nico.json](https://github.com/lepture/ganam/blob/master/nico.json) of this project, and learn how to use it. BTW, you must have `ganam` installed to active `GanamWriter`.
Watch it: https://github.com/lepture/ganam-cli

0 comments on commit e3588b2

Please sign in to comment.