From 66dfe314605ecba186d36e9362271ef00aff5a59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rcio=20Almada?= Date: Sun, 14 Sep 2014 22:59:41 -0300 Subject: [PATCH] more README tweaks, ready for 2.0 release :) --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 60d02b6..8cd25ba 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ use Minime\Annotations\Cache\ArrayCache; $reader = new Reader(new Parser, new ArrayCache); ``` -`Reader::createFromDefaults()` creates a reader instance with array cache enabled. +Notice that `Reader::createFromDefaults()` creates a reader instance with array cache enabled. On production you might want to use a persistent cache handler like `FileCache` instead: ```php @@ -51,7 +51,7 @@ $reader->setCache(new FileCache('app/storage/path')); ## Reading Annotations -Consider the following class with docblock annotations: +Consider the following class with some docblock annotations: ```php useNamespace('response')->toArray(); ### Piping Filters -You can easily "pipe" filters. This time we will grep all annotations beginning with "x" and within +You can also easily "pipe" filters. This time let's "grep" all annotations beginning with "x" and within "response" namespace: ```php @@ -259,8 +259,8 @@ VoilĂ ! Instantly classy annotations. ## Caching -This package comes with two cache handlers. `ArrayCache` (for testing) and a very basic `FileCache` -for persistence. Cache handler can be set during `Minime\Annotations\Reader` instantiation: +This package comes with two basic cache handlers. `ArrayCache` (for testing) and a very simple `FileCache` +handler for persistence. Cache handlers can be set during `Minime\Annotations\Reader` instantiation: ```php use Minime\Annotations\Reader;