diff options
authorflip111 <flip101@gmail.com>2014-02-11 09:29:13 +0100
committerflip111 <flip101@gmail.com>2014-03-27 22:11:49 +0100
commit00f82fd8b1603fd9fb7eb5093be4ea8b188f5dd3 (patch)
parent81722b7979929325b3335119b6d00c4ed782f6fc (diff)
Englishfied README.md
Still documentation is still missing a use case. Why not use APC instead ??
1 files changed, 2 insertions, 6 deletions
diff --git a/README.md b/README.md
index 2ccf308..8baeb46 100644
--- a/README.md
+++ b/README.md
@@ -5,12 +5,11 @@ Moreover, Hoa aims at being a bridge between industrial and research worlds.
# Hoa\Registry ![state](http://central.hoa-project.net/State/Registry)
-This library proposes a static register with facilities.
+This library offers a static registry that stores key/value combinations. Any kind of PHP variable can be stored: an array, an object, a resource, etc..
## Quick usage
-As a quick overview, we propose to set an entry and retrieve it from the
-`hoa://` protocol:
+As a quick example, we set an entry and retrieve it. The retrieval can be done with a static method on the `Hoa\Registry\Registry` class and also using the `hoa://` protocol.
Hoa\Register\Registry::set('foo', 'bar');
@@ -24,9 +23,6 @@ As a quick overview, we propose to set an entry and retrieve it from the
* string(3) "bar"
-There is no restriction about the key form or the value type. We can store any
-kinds of type: objects, functions, resources…
## Documentation
Different documentations can be found on the website: