Basic readme

Author: WyriHaximus

README.md

@@ -1,2 +1,66 @@
-# reactphp-parallel
-ReactPHP bindings around ext-parallel
+# ReactPHP Runtime wrapper for ext-parallel
+
+[![Linux Build Status](https://travis-ci.org/WyriHaximus/reactphp-parallel-runtime.png)](https://travis-ci.org/WyriHaximus/reactphp-parallel-runtime)
+[![Windows Build status](https://ci.appveyor.com/api/projects/status/1sfdh9g2pvbuw4pp?svg=true)](https://ci.appveyor.com/project/WyriHaximus/reactphp-parallel-runtime)
+[![Latest Stable Version](https://poser.pugx.org/WyriHaximus/react-parallel-runtime/v/stable.png)](https://packagist.org/packages/WyriHaximus/react-parallel-runtime)
+[![Total Downloads](https://poser.pugx.org/WyriHaximus/react-parallel-runtime/downloads.png)](https://packagist.org/packages/WyriHaximus/react-parallel-runtime)
+[![Code Coverage](https://scrutinizer-ci.com/g/WyriHaximus/reactphp-parallel-runtime/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/WyriHaximus/reactphp-parallel-runtime/?branch=master)
+[![License](https://poser.pugx.org/WyriHaximus/react-parallel-runtime/license.png)](https://packagist.org/packages/wyrihaximus/react-parallel-runtime)
+[![PHP 7 ready](http://php7ready.timesplinter.ch/WyriHaximus/reactphp-parallel-runtime/badge.svg)](https://travis-ci.org/WyriHaximus/reactphp-parallel-runtime)
+
+### Installation ###
+
+To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `~`.
+
+```
+composer require wyrihaximus/react-parallel-runtime 
+```
+
+# Usage
+
+```php
+$autoloader = \dirname(__DIR__) . '/vendor/autoload.php';
+require $autoloader;
+
+$loop = Factory::create();
+$runtime = new Runtime(new FutureToPromiseConverter($loop), $autoloader);
+
+$runtime->run(function () {
+    sleep(3);
+
+    return 3;
+})->then(function (int $int): void {
+    echo $int, PHP_EOL;
+});
+
+$loop->run();
+```
+
+## Contributing ##
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## License ##
+
+Copyright 2019 [Cees-Jan Kiewiet](http://wyrihaximus.net/)
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.