Update README.md

Author: AndrewCarterUK

README.md

@@ -1,2 +1,71 @@
-# ExpressiveAdapter
-A package that allows Zend Expressive applications to reduce overheads by running as a FastCGI daemon. http://phpfastcgi.github.io/
+# PHPFastCGI Zend Expressive Adapter
+
+[![Latest Stable Version](https://poser.pugx.org/phpfastcgi/expressive-adapter/v/stable)](https://packagist.org/packages/phpfastcgi/expressive-adapter)
+[![Build Status](https://travis-ci.org/PHPFastCGI/ExpressiveAdapter.svg?branch=v0.5.0)](https://travis-ci.org/PHPFastCGI/ExpressiveAdapter)
+[![Coverage Status](https://coveralls.io/repos/PHPFastCGI/ExpressiveAdapter/badge.svg?branch=master&service=github)](https://coveralls.io/github/PHPFastCGI/ExpressiveAdapter?branch=master)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PHPFastCGI/ExpressiveAdapter/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/PHPFastCGI/ExpressiveAdapter/?branch=master)
+[![Total Downloads](https://poser.pugx.org/phpfastcgi/expressive-adapter/downloads)](https://packagist.org/packages/phpfastcgi/expressive-adapter)
+
+A PHP package which allows Zend Expressive applications to reduce overheads by exposing their Request-Response structure to a FastCGI daemon.
+
+Visit the [project website](http://phpfastcgi.github.io/).
+
+## Introduction
+
+Using this package, Zend Expressive applications can stay alive between HTTP requests whilst operating behind the protection of a FastCGI enabled web server.
+
+## Current Status
+
+This project is currently in early stages of development and not considered stable. Importantly, this library currently lacks support for uploaded files.
+
+Contributions and suggestions are welcome.
+
+## Installing
+
+```sh
+composer require "phpfastcgi/expressive-adapter:^0.1"
+```
+
+## Usage
+
+```php
+<?php // command.php
+
+// Include the composer autoloader
+require_once dirname(__FILE__) . '/../vendor/autoload.php';
+
+use PHPFastCGI\FastCGIDaemon\ApplicationFactory;
+use PHPFastCGI\Adapter\Expressive\AppWrapper;
+use Zend\Expressive\AppFactory;
+
+// Create your Expressive app
+$app = AppFactory::create();
+$app->get('/', function ($request, $response, $next) {
+    $response->getBody()->write('Hello, World!');
+    return $response;
+});
+
+// Create the kernel for the FastCGIDaemon library (from the Expressive app)
+$kernel = new AppWrapper($app);
+
+// Create the symfony console application
+$consoleApplication = (new ApplicationFactory)->createApplication($kernel);
+
+// Run the symfony console application
+$consoleApplication->run();
+```
+
+If you wish to configure your FastCGI application to work with the apache web server, you can use the apache FastCGI module to process manage your application.
+
+This can be done by creating a FastCGI script that launches your application and inserting a FastCgiServer directive into your virtual host configuration.
+
+```sh
+#!/bin/bash
+php /path/to/command.php run
+```
+
+```
+FastCgiServer /path/to/web/root/script.fcgi
+```
+
+If you are using a web server such as nginx, you will need to use a process manager to monitor and run your application.