Skip to content

Commit

Permalink
update readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeed committed Feb 21, 2017
1 parent 61b07ca commit 12d64b4
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 31 deletions.
46 changes: 15 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,32 @@
</a>
</div>

> [CoffeeScript](http://coffeescript.org/) plugin for _[Fly][fly]_.
# fly-coffee [![][travis-badge]][travis-link]

[![][fly-badge]][fly]
[![npm package][npm-ver-link]][releases]
[![][dl-badge]][npm-pkg-link]
[![][travis-badge]][travis-link]
[![][mit-badge]][mit]
> [CoffeeScript](http://coffeescript.org/) plugin for Fly.
## Usage
> Check out the [documentation](http://coffeescript.org/documentation/docs/command.html#section-5) to see the available options.

### Install
## Install

```a
npm install -D fly-coffee
npm install --save-dev fly-coffee
```

### Example
## Usage

Check out the [documentation](http://coffeescript.org/#usage) to see the available options.

```js
export build = function* () {
yield this
.source("src/**/*.coffee")
.coffee()
.target("dist/")
exports.coffee = function * (fly) {
yield fly.source("src/**/*.coffee").coffee({
sourceMap: true
}).target("dist/js")
}
```

# License

[MIT][mit] © [Jorge Bucaran][author] et [al][contributors]
## License

MIT © [FlyJS](https://www.github.com/flyjs/fly)

[mit]: http://opensource.org/licenses/MIT
[author]: http://about.bucaran.me
[contributors]: https://github.com/bucaran/fly-coffee/graphs/contributors
[releases]: https://github.com/bucaran/fly-coffee/releases
[fly]: https://www.github.com/flyjs/fly
[fly-badge]: https://img.shields.io/badge/fly-JS-05B3E1.svg?style=flat-square
[mit-badge]: https://img.shields.io/badge/license-MIT-444444.svg?style=flat-square
[npm-pkg-link]: https://www.npmjs.org/package/fly-coffee
[npm-ver-link]: https://img.shields.io/npm/v/fly-coffee.svg?style=flat-square
[dl-badge]: http://img.shields.io/npm/dm/fly-coffee.svg?style=flat-square
[travis-link]: https://travis-ci.org/bucaran/fly-coffee
[travis-badge]: http://img.shields.io/travis/bucaran/fly-coffee.svg?style=flat-square
[travis-link]: https://travis-ci.org/flyjs/fly-coffee
[travis-badge]: http://img.shields.io/travis/flyjs/fly-coffee.svg?style=flat-square
7 changes: 7 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@
"test": "tape test/*.js | tap-spec"
},
"author": "Jorge Bucaran",
"contributors": [
{
"name": "Luke Edwards",
"email": "luke@lukeed.com",
"url": "https://lukeed.com"
}
],
"dependencies": {
"coffee-script": "^1.9.3"
},
Expand Down

0 comments on commit 12d64b4

Please sign in to comment.