Skip to content
This repository has been archived by the owner on Dec 7, 2020. It is now read-only.

Include installation and usage in README.md #109

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 38 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

-----

Expand All @@ -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

```
<script src="legacy.js"></script><!-- for old browsers -->
<script src="asq.js"></script>
```

## Explanation

### TL;DR: By Example

* [Sequences & gates](https://gist.github.com/getify/5959149), at a glance
Expand Down Expand Up @@ -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.
Expand Down