amp/README.md

# amp

[![Build Status](https://img.shields.io/travis/amphp/amp/master.svg?style=flat-square)](https://travis-ci.org/amphp/amp)
[![CoverageStatus](https://img.shields.io/coveralls/amphp/amp/master.svg?style=flat-square)](https://coveralls.io/github/amphp/amp?branch=master)
![Unstable v2](https://img.shields.io/badge/unstable-v2-green.svg?style=flat-square)
![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)

`amphp/amp` is a non-blocking concurrency framework for PHP. It provides an event loop, promises and streams as a base for asynchronous programming.

Promises in combination with generators are used to build coroutines, which allow writing asynchronous code just like synchronous code, without any callbacks.

## Installation

This package can be installed as a [Composer](https://getcomposer.org/) dependency.

```bash
composer require amphp/amp ^2@dev
```

## Requirements

- PHP 7.0+

##### Optional Extension Backends

Extensions are only needed if your app necessitates a high numbers of concurrent socket connections.

- [ev](https://pecl.php.net/package/ev)
- [libevent](https://pecl.php.net/package/libevent)
- [php-uv](https://github.com/bwoebi/php-uv) (experimental fork)

## Documentation

Documentation is bundled within this repository in the [`./docs`](./docs) directory.

## Versioning

`amphp/amp` follows the [semver](http://semver.org/) semantic versioning specification like all other `amphp` packages.

## Compatible Packages

Compatible packages should use the [`amphp`](https://github.com/search?utf8=%E2%9C%93&q=topic%3Aamphp) topic on GitHub.

## Security

If you discover any security related issues, please email [`bobwei9@hotmail.com`](mailto:bobwei9@hotmail.com) or [`me@kelunik.com`](mailto:me@kelunik.com) instead of using the issue tracker.

## License

The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
support file updates 2015-07-19 19:29:25 +02:00			`# amp`
Add travis support 2015-04-29 17:29:09 +02:00
update badges 2015-07-28 15:09:42 +02:00			`[![Build Status](https://img.shields.io/travis/amphp/amp/master.svg?style=flat-square)](https://travis-ci.org/amphp/amp)`
			`[![CoverageStatus](https://img.shields.io/coveralls/amphp/amp/master.svg?style=flat-square)](https://coveralls.io/github/amphp/amp?branch=master)`
Mark v2 as unstable 2017-03-12 18:33:12 +01:00			`![Unstable v2](https://img.shields.io/badge/unstable-v2-green.svg?style=flat-square)`
update badges 2015-07-28 15:09:42 +02:00			`![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)`
support file updates 2015-07-19 19:29:25 +02:00
Update README to v2 2017-03-12 12:44:32 +01:00			`amphp/amp` is a non-blocking concurrency framework for PHP. It provides an event loop, promises and streams as a base for asynchronous programming.
Improve README, add documentation 2017-03-13 13:16:59 +01:00
Update managing-concurrency to v2, updating the docs for helpers still outstanding, fixes #78 2017-03-13 15:49:25 +01:00			`Promises in combination with generators are used to build coroutines, which allow writing asynchronous code just like synchronous code, without any callbacks.`
Updated changelog and readme for v0.3.0 2013-11-24 17:30:03 +01:00
Improve README, add documentation 2017-03-13 13:16:59 +01:00			`## Installation`

			`This package can be installed as a [Composer](https://getcomposer.org/) dependency.`

			```bash
			`composer require amphp/amp ^2@dev`
			```

			`## Requirements`
Initial release commit 2013-08-05 22:05:08 +02:00
Update README to v2 2017-03-12 12:44:32 +01:00			`- PHP 7.0+`
update readme 2015-07-22 06:06:02 +02:00
Improve README, add documentation 2017-03-13 13:16:59 +01:00			`##### Optional Extension Backends`
update readme 2015-07-22 06:06:02 +02:00
Improve README, add documentation 2017-03-13 13:16:59 +01:00			`Extensions are only needed if your app necessitates a high numbers of concurrent socket connections.`
Add note about extension backends 2015-11-01 03:54:13 +01:00
update readme 2015-07-22 06:06:02 +02:00			`- [ev](https://pecl.php.net/package/ev)`
			`- [libevent](https://pecl.php.net/package/libevent)`
Improve README, add documentation 2017-03-13 13:16:59 +01:00			`- [php-uv](https://github.com/bwoebi/php-uv) (experimental fork)`
update support files 2015-05-12 21:18:28 +02:00
Improve README, add documentation 2017-03-13 13:16:59 +01:00			`## Documentation`
more fun with readme 2014-08-07 07:35:17 +02:00
Fix typo 2017-03-13 13:19:23 +01:00			Documentation is bundled within this repository in the [`./docs`](./docs) directory.
Improve README, add documentation 2017-03-13 13:16:59 +01:00
			`## Versioning`

			`amphp/amp` follows the [semver](http://semver.org/) semantic versioning specification like all other `amphp` packages.

			`## Compatible Packages`

			Compatible packages should use the [`amphp`](https://github.com/search?utf8=%E2%9C%93&q=topic%3Aamphp) topic on GitHub.

			`## Security`

			If you discover any security related issues, please email [`bobwei9@hotmail.com`](mailto:bobwei9@hotmail.com) or [`me@kelunik.com`](mailto:me@kelunik.com) instead of using the issue tracker.

			`## License`

Update managing-concurrency to v2, updating the docs for helpers still outstanding, fixes #78 2017-03-13 15:49:25 +01:00			The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.