diff --git a/README.md b/README.md index 4f7e42c..f3aa584 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,7 @@ Promise-style async sequence flow control. -## Explanation - -*asynquence* ("async" + "sequence") is an abstraction on top of promises (promise chains) that lets you express flow control steps with callbacks, promises, or generators. +*asynquence* ("async" + "sequence") is an abstraction on top of promises (promise chains) that lets you express flow control steps with callbacks, promises, or generators. See explanation below. ----- @@ -17,6 +15,43 @@ If you're interested in detailed discussion about *asynquence*, here's some read ----- +## Installation and Usage + +### Get package + +- Clone or download this repository + + ```git clone https://github.com/getify/asynquence.git``` + +- or install via npm + + ```npm i asynquence``` + +### Build + +The core library file can be built (minified) with an included utility: + +``` +./build-core.js +``` + +However, the recommended way to invoke this utility is via npm: + +``` +npm run-script build-core +``` + +### Use + +- Include in your html file + +``` + + +``` + +## Explanation + ### TL;DR: By Example * [Sequences & gates](https://gist.github.com/getify/5959149), at a glance @@ -582,20 +617,6 @@ ASQ() .then(yay); ``` -## Builds - -The core library file can be built (minified) with an included utility: - -``` -./build-core.js -``` - -However, the recommended way to invoke this utility is via npm: - -``` -npm run-script build-core -``` - ## License The code and all the documentation are released under the MIT license.