Skip to content

Commit

Permalink
update docs ❤️
Browse files Browse the repository at this point in the history
  • Loading branch information
Jorge Bucaran committed Jul 3, 2015
2 parents bc33daa + 4b2103e commit 4ea6bef
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 36 deletions.
51 changes: 32 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,45 @@
> New Generation Build System
[![][fly-badge]][fly]
[![][dl-badge]][npm-pkg-link]
![][mit-badge]
[![][TravisLogo]][Travis]


<p align="center">
<a href="http://github.com/flyjs/fly">
<img width=300px src="https://cloud.githubusercontent.com/assets/8317250/8430194/35c6043a-1f6a-11e5-8cbd-af6cc86baa84.png">
</a>
</p>


<p align="center">
<b><a href="#about">About</a></b>
|
<b><a href="#usage">Usage</a></b>
|
<b><a href="/docs/README.md">Documentation</a></b>
|
<b><a href="https://github.com/flyjs/fly/wiki#plugins">Plugins</a></b>
|
<b><a href="#contributing">Contributing</a></b>
<b><a href="#about">About</a></b>
|
<b><a href="#usage">Usage</a></b>
|
<b><a href="/docs/README.md">Documentation</a></b>
|
<b><a href="https://github.com/flyjs/fly/wiki#plugins">Plugins</a></b>
|
<b><a href="#contributing">Contributing</a></b>

<p align="center">
<a href="https://gitter.im/flyjs/fly?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
<img src="https://badges.gitter.im/Join%20Chat.svg">
</a>
</p>
</p>
<br>

[![][fly-badge]][fly]
[![][dl-badge]][npm-pkg-link]
![][mit-badge]
[![][TravisLogo]][Travis]

> New Generation Build System
<br>


## About

_Fly_ is a [build system](https://en.wikipedia.org/wiki/Build_automation) for [Node](https://nodejs.org/) based in [ES6](http://www.ecma-international.org/ecma-262/6.0/index.html) [generators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*) and [promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that aims to be simple and elegant to write.
_Fly_ is a [build system](https://en.wikipedia.org/wiki/Build_automation) for [Node](https://nodejs.org/) based in [_co_-routines](https://medium.com/@tjholowaychuk/callbacks-vs-coroutines-174f1fe66127), [generators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*) and [promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that aims to be simple and elegant to write.

See the [Documentation](/docs/README.md) page to learn more.
See the [Documentation](/docs/README.md) page to learn more about how to use Fly and write your own [plugins](/docs/README.md#plugins).

## Usage
### Install
Expand All @@ -39,7 +50,7 @@ npm install fly

### _Flyfile_

> Flyfiles can be written in ES5/6/7 and [others](https://github.com/jashkenas/coffeescript/wiki/List-of-languages-that-compile-to-JS).
> Flyfiles can be written in ES5/[6](/examples/Flyfile.babel.js)/[7](/examples/Flyfile7.babel.js) and [other](https://github.com/jashkenas/coffeescript/wiki/List-of-languages-that-compile-to-JS) JavaScript variants.
```js
const paths = {
Expand Down Expand Up @@ -68,7 +79,9 @@ Contributions are absolutely welcome. Check out our [contribution guide](/CONTRI
# Roadmap ✈

+ Proper tests.
+ Configuration options (disable plugin auto-loading, etc.)
+ Configuration options.
+ Fly's build should be written in Fly.
+ Optimize stream operations using [CSP channels](https://en.wikipedia.org/wiki/Communicating_sequential_processes).

# License

Expand Down
21 changes: 5 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,18 +143,15 @@ Log a message with a time stamp.
#### `Fly.prototype.reset ()`
Reset the internal state of the Fly instance.

#### `Fly.prototype.clear (...paths)`
[rimraf](https://github.com/isaacs/rimraf) wrapper. Clear each specified directory.

#### `Fly.prototype.concat (name)`
Concatenate files read with `Fly.prototype.source`.

#### `Fly.prototype.filter (...filters)`
Add a sync filter / transform to the promise-pipeline. For async filters, you must wrap the function into a promise using `Fly.prototype.defer` for example.
Add a sync filter / transform to the promise-pipeline. For async filters, you must wrap the function into a promise using `Fly.prototype.defer` or promisify it yourself.

#### `Fly.prototype.watch (globs, ...tasks)`
#### `Fly.prototype.watch ([globs], [tasks])`

Run the specified tasks when a change is detected in any of the paths that expand from `globs`.
Run the specified tasks when a change is detected in any of the paths expanded from `globs`.

#### `Fly.prototype.start (tasks = [])`

Expand All @@ -175,22 +172,14 @@ This method can be used when creating plugins that need to read the source promi

Resolves all source promises and writes to each of the destination paths.

### External Dependencies

* [co](https://github.com/tj/co)
* [mz/fs](https://github.com/normalize/mz)
* [mkdirp](https://github.com/substack/node-mkdirp)
* [rimraf](https://github.com/isaacs/rimraf)
* [glob](https://github.com/isaacs/node-glob)
* [chokidar](https://github.com/paulmillr/chokidar)

## Plugins

> See the [Wiki](https://github.com/flyjs/fly/wiki) for the list of currently supported plugins.
> See [this gist](https://gist.github.com/bucaran/f018ade8dee8ae189407) for an example README template for your Fly plugins.
Plugins are regular node modules that export a single default method. This method method is invoked when a new Fly instance is created.
Plugins are regular node modules that export a single default method. This method is automatically run when a new Fly instance is created. The following adds a new method to the Fly instance:


```js
module.exports = function () {
Expand Down
2 changes: 1 addition & 1 deletion examples/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"fly-coffee": "0.0.1",
"fly-eslint": "0.0.1",
"fly-mocha": "0.0.1",
"fly-uglify": "0.0.1"
"fly-uglify": "0.0.2"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
Expand Down

0 comments on commit 4ea6bef

Please sign in to comment.