From 95e1641ffaf9ce95bcb9202d2b44d6d95f91168b Mon Sep 17 00:00:00 2001 From: Niklas Keller Date: Thu, 8 Mar 2018 13:56:16 +0100 Subject: [PATCH] Update README --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 45df8ae..66212e4 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,29 @@ -

-process -

+# process -

+

Build Status Code Coverage Release License

-

Async process dispatcher built on the Amp concurrency framework.

+This package provides an asynchronous process dispatcher that works on all major platforms (including Windows). + +As Windows pipes are file handles and do not allow non-blocking access, this package makes use of a [process wrapper](https://github.com/amphp/windows-process-wrapper), that provides access to these pipes via sockets. +On Unix-like systems it uses the standard pipes, as these can be accessed without blocking there. +Concurrency is managed by the [Amp](https://github.com/amphp/amp) event loop. ## Installation This package can be installed as a [Composer](https://getcomposer.org/) dependency. -```bash +``` composer require amphp/process ``` ## Requirements * PHP 7.0+ -* [Amp framework](https://github.com/amphp/amp) (installed via composer) ## Versioning