Merge pull request #4 from Nyholm/docs

Added docs

Author: cryptiklemur

.travis.yml

@@ -1,8 +1,9 @@
 language: php
 php:
-  - "7.0"
-  - "5.6"
-  - "5.5"
+  - 7.0
+  - 5.6
+  - 5.5
+  - hhvm
 
 sudo: false
 
@@ -13,11 +14,11 @@ matrix:
   fast_finish: true
 
 before_install:
-    - phpenv config-rm xdebug.ini
+    - if [[ $TRAVIS_PHP_VERSION != 'hhvm' ]]; then phpenv config-rm xdebug.ini; fi;
     - pip install --user codecov
 
 before_script:
-    - echo "extension = memcached.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+    - if [[ $TRAVIS_PHP_VERSION != 'hhvm' ]]; then echo "extension = memcached.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini; fi;
     - travis_retry composer self-update
     - travis_retry composer install --prefer-source --no-interaction
 

README.md

@@ -1,4 +1,21 @@
-# Memcached PSR-6 adapter 
-[![Build Status](https://travis-ci.org/php-cache/memcached-adapter.svg?branch=master)](https://travis-ci.org/php-cache/memcached-adapter) [![codecov.io](https://codecov.io/github/php-cache/memcached-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/memcached-adapter?branch=master)
+# Memcached PSR-6 Cache pool 
+[![Latest Stable Version](https://poser.pugx.org/cache/memcached-adapter/v/stable)](https://packagist.org/packages/cache/memcached-adapter) [![codecov.io](https://codecov.io/github/php-cache/memcached-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/memcached-adapter?branch=master) [![Build Status](https://travis-ci.org/php-cache/memcached-adapter.svg?branch=master)](https://travis-ci.org/php-cache/memcached-adapter) [![Total Downloads](https://poser.pugx.org/cache/memcached-adapter/downloads)](https://packagist.org/packages/cache/memcached-adapter)  [![Monthly Downloads](https://poser.pugx.org/cache/memcached-adapter/d/monthly.png)](https://packagist.org/packages/cache/memcached-adapter) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
-This is a implementation for the PSR-6 for Memcached cache. This implementation supports tags. 
+This is a PSR-6 cache implementation Memcached. It is a part of the PHP Cache organisation. To read about 
+features like tagging and hierarchy support please read the shared documentation at [www.php-cache.com](http://www.php-cache.com). 
+
+### Install
+
+```bash
+composer require cache/memcached-adapter
+```
+
+### Configure
+
+To create an instance of `MemcachedCachePool` you need to configure a `\Memcached` client. 
+
+```php
+$client = new \Memcached();
+$client->addServer('localhost', 11211);
+$pool = new MemcachedCachePool($client);
+```

src/MemcachedCachePool.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of php-cache\mencached-adapter package.
+ * This file is part of php-cache\memcached-adapter package.
  *
  * (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
  *

tests/IntegrationPoolTest.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of php-cache\mencached-adapter package.
+ * This file is part of php-cache\memcached-adapter package.
  *
  * (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
  *

tests/IntegrationTagTest.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of php-cache\mencached-adapter package.
+ * This file is part of php-cache\memcached-adapter package.
  *
  * (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
  *