From 08cb5d3e576893feffb42eb0ad806fef865eef1f Mon Sep 17 00:00:00 2001
From: Richard <rvanlaak@gmail.com>
Date: Tue, 31 May 2016 18:35:56 +0200
Subject: [PATCH] Document PSR-6 cache adapters

---
 README.md     | 46 ++++++++++++++++++++++++++++++++++++++--------
 composer.json |  6 ++++--
 2 files changed, 42 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 77021be..365c7c0 100644
--- a/README.md
+++ b/README.md
@@ -11,8 +11,8 @@ Symfony Bundle for [asm89/twig-cache-extension](https://github.com/asm89/twig-ca
 
 API: [emanueleminotto.github.io/TwigCacheBundle](http://emanueleminotto.github.io/TwigCacheBundle/)
 
-Step 1: Download the Bundle
----------------------------
+Install bundle using Composer
+-----------------------------
 
 Open a command console, enter your project directory and execute the
 following command to download the latest stable version of this bundle:
@@ -25,8 +25,8 @@ This command requires you to have [Composer](https://getcomposer.org/) installed
 in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
 of the Composer documentation.
 
-Step 2: Enable the Bundle
--------------------------
+Add Bundle to AppKernel
+-----------------------
 
 Then, enable the bundle by adding the following line in the `app/AppKernel.php`
 file of your project:
@@ -48,19 +48,49 @@ class AppKernel extends Kernel
 }
 ```
 
-Step 3: Configuration
----------------------
+Configure services
+------------------
+
+This bundle allows to easily configure the caching service the extension will use for the caching. The extension 
+by default supports instances of `Doctrine\Common\Cache\Cache` but allows you to use packages that 
+provide a `psr/cache-implementation`.
 
 ```yml
 # app/config/config.yml
 twig_cache:
-    service: cache_service # instance of Doctrine\Common\Cache\Cache
+    service: cache_service # instance of Doctrine\Common\Cache\Cache or Psr\Cache\CacheItemPoolInterface
+```
+
+Configuring a PSR-6 Cache pool implementation is possible by changing the extension's default adapter class 
+to the `PsrCacheAdapter` that is provided with the extension.
+
+```yml
+# parameters.yml
+twig_cache.adapter.class: Asm89\Twig\CacheExtension\CacheProvider\PsrCacheAdapter
+```
+
+After that, you should install a package that provides a `psr/cache-implementation`. A wide
+variety of implementations already can be found at: [http://php-cache.readthedocs.io/](http://php-cache.readthedocs.io/)
+After installing an adapter with composer, it can be configured to do the caching for this bundle. 
+The [`CacheBundle`](https://github.com/php-cache/cache-bundle) allows easy configuration by creating a Symfony
+service for the cache pool adapter.
+
+```yml
+# config.yml
+cache_adapter:
+    providers:
+        twig_apcu:
+            factory: 'cache.factory.apcu'
+
+twig_cache:
+    service: cache.provider.twig_apcu
 ```
 
 Usage
 -----
 
-The default strategy is the `IndexedChainingCacheStrategy` so you can use directly this code in your [Twig](http://twig.sensiolabs.org/) templates.
+The default strategy is the `IndexedChainingCacheStrategy` so you can use directly this code in your 
+[Twig](http://twig.sensiolabs.org/) templates.
 
 ```twig
 {# delegate to lifetime strategy #}
diff --git a/composer.json b/composer.json
index f4d965a..50050e5 100644
--- a/composer.json
+++ b/composer.json
@@ -15,7 +15,7 @@
         }
     ],
     "require": {
-        "asm89/twig-cache-extension": "^1.0"
+        "asm89/twig-cache-extension": "^1.3"
     },
     "require-dev": {
         "doctrine/cache": "^1.4",
@@ -38,6 +38,8 @@
         }
     },
     "suggest": {
-        "itinance/doctrine-cache-adapter-with-site-context": "a Cache Adapter used to respect the current site context in a white-label/multi-site environment"
+        "itinance/doctrine-cache-adapter-with-site-context": "a Cache Adapter used to respect the current site context in a white-label/multi-site environment",
+        "cache/adapter-bundle": "To make use of PSR-6 cache implementation via PsrCacheAdapter.",
+        "cache/cache-bundle": "To easily be able to configure adapters in your Symfony application."
     }
 }