creamer
Version:
A flatiron plugin for dynamic coffeecup templates
104 lines (68 loc) • 2.34 kB
Markdown
# Creamer
[](http://travis-ci.org/twilson63/creamer)
Creamer is a server side flatiron plugin that provides coffeecup views and easy controller mounting.
## install
`npm install creamer`
## usage
``` coffeescript
flatiron = require 'flatiron'
creamer = require 'creamer'
app = flatiron.app
layout = require __dirname + '/views/layout'
app.use creamer, layout: layout, viewDir: __dirname + '/views'
app.get '/', -> @bind('index')
app.start 3000
```
## api
options
option | Description
-----------|----------|-------------|-------------
layout | coffeecup layout
views | directory to your views
controllers| directory to your controllers
## app.bind(template, data)
Parameter | Type | Required | Description
-----------|----------|-------------|-------------
template | function | yes | coffeecup template
data | object | no | any data you want to pass to your template
example
``` coffeescript
app.router.get '/', -> @bind('index')
```
## app.registerHelper(name, fn)
register any helper to your coffeecup
Parameter | Type | Required? | Description
-------------|-----------|-------------|------------------------
name | string | yes | name of helper
fn | function | yes | coffeecup function
example
```
app.registerHelper 'foo', (baz) -> baz + 'bar'
```
## app.registerView(name, fn)
register view
Parameter | Type | Required? | Description
-------------|-----------|-------------|------------------------
name | string | yes | name of helper
fn | function | yes | coffeecup function
# roadmap
check [issues][1]
# contribute
everyone is welcome to contribute. patches, bugfixes, new features
1. create an [issue][1] on github so the community can comment on your idea
2. fork `creamer` in github
3. create a new branch `git checkout -b my_branch`
4. create tests for the changes you made
5. make sure you pass both existing and newly inserted tests
6. commit your changes
7. push to your branch `git push origin my_branch`
8. create an pull request
# tests
``` sh
npm install mocha -g
npm install
npm test
```
# license
see LICENSE
[1]: http://github.com/twilson63/creamer/issues