diff --git a/README.md b/README.md index f3cfde5..cd279d3 100644 --- a/README.md +++ b/README.md @@ -2,28 +2,15 @@ **True concurrency using native threading and multiprocessing for parallelizing code, *without* blocking.** -This library is a component for [Amp](https://github.com/icicleio/icicle) that provides native threading, multiprocessing, process synchronization, shared memory, and task workers. Like other Amp components, this library uses [Coroutines](https://icicle.io/docs/manual/coroutines/) built from [Awaitables](https://icicle.io/docs/manual/awaitables/) and [Generators](http://www.php.net/manual/en/language.generators.overview.php) to make writing asynchronous code more like writing synchronous code. - -[![Build Status](https://img.shields.io/travis/icicleio/concurrent/v1.x.svg?style=flat-square)](https://travis-ci.org/icicleio/concurrent) -[![Coverage Status](https://img.shields.io/coveralls/icicleio/concurrent/v1.x.svg?style=flat-square)](https://coveralls.io/r/icicleio/concurrent) -[![Semantic Version](https://img.shields.io/github/release/icicleio/concurrent.svg?style=flat-square)](http://semver.org) -[![MIT License](https://img.shields.io/packagist/l/icicleio/concurrent.svg?style=flat-square)](LICENSE) -[![@icicleio on Twitter](https://img.shields.io/badge/twitter-%40icicleio-5189c7.svg?style=flat-square)](https://twitter.com/icicleio) +This library is a component for [Amp](https://amphp.org) that provides native threading, multiprocessing, process synchronization, shared memory, and task workers. Like other Amp components, this library uses Coroutines built from Awaitables and [Generators](http://www.php.net/manual/en/language.generators.overview.php) to make writing asynchronous code more like writing synchronous code. This library provides a means of parallelizing code without littering your application with complicated lock checking and inter-process communication. To be as flexible as possible, this library comes with a collection of non-blocking concurrency tools that can be used independently as needed, as well as an "opinionated" worker API that allows you to assign units of work to a pool of worker threads or processes. -#### Documentation and Support - -- [Full API Documentation](https://icicle.io/docs/api/Concurrent/) -- [Official Twitter](https://twitter.com/icicleio) -- [Gitter Chat](https://gitter.im/icicleio/icicle) - ##### Requirements -- PHP 5.5+ for v0.3.x branch (current stable) and v1.x branch (mirrors current stable) -- PHP 7 for v2.0 (master) branch supporting generator delegation and return expressions +- PHP 7 (no extensions required) ##### Suggested @@ -38,7 +25,7 @@ The recommended way to install is with the [Composer](http://getcomposer.org/) p Run the following command to use this package in your project: ```bash -composer require icicleio/concurrent +composer require amphp/concurrent ``` You can also manually edit `composer.json` to add this library as a project requirement. @@ -47,15 +34,13 @@ You can also manually edit `composer.json` to add this library as a project requ // composer.json { "require": { - "icicleio/concurrent": "^0.3" + "amphp/concurrent": "dev-master" } } ``` ### Development and Contributing -Interested in contributing to Amp? Please see our [contributing guidelines](https://github.com/icicleio/icicle/blob/master/CONTRIBUTING.md) in the [Amp repository](https://github.com/icicleio/icicle). - Want to hack on the source? A [Vagrant](http://vagrantup.com) box is provided with the repository to give a common development environment for running concurrent threads and processes, and comes with a bunch of handy tools and scripts for testing and experimentation. Starting up and logging into the virtual machine is as simple as