Skip to content

Commit d2e7056

Browse files
committed
Add about section to README explaining what it does and that you need a loop
1 parent c11626e commit d2e7056

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,23 @@ It is heavily influenced by [async.js](https://github.com/caolan/async).
66

77
[![Build Status](https://secure.travis-ci.org/reactphp/async.png?branch=master)](http://travis-ci.org/reactphp/async)
88

9+
## About
10+
11+
This library allows you to manage async control flow. It provides a number of
12+
combinators for continuation-passing style (aka callbacks). Instead of nesting
13+
those callbacks, you can declare them as a list, which is resolved
14+
sequentially in an async manner.
15+
16+
React/Async will not automagically change blocking code to be async. You need
17+
to have an actual event loop and non-blocking libraries interacting with that
18+
event loop for it to work. You can use `react/event-loop` for this, but you
19+
don't have to. As long as you have a callback-based API, it can be used with
20+
this library.
21+
922
## Install
1023

11-
The recommended way to install react/async is [through composer](http://getcomposer.org).
24+
The recommended way to install react/async is [through
25+
composer](http://getcomposer.org).
1226

1327
```JSON
1428
{

0 commit comments

Comments
 (0)