aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2014-05-14 09:24:20 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2014-05-14 09:24:20 +0200
commita17555d4baf6cea46e2079c13332fa0ae520d52d (patch)
treed4426c272ad38fbaf7eceb78d7273674f0181b2e
parent5b7ea3cf9c33aedf6844a6768d75028e36c10f6a (diff)
parent502873b049b5ff0fa2b9e2096df88b534faffab3 (diff)
downloadRegistry-a17555d4baf6cea46e2079c13332fa0ae520d52d.zip
Registry-a17555d4baf6cea46e2079c13332fa0ae520d52d.tar.gz
Registry-a17555d4baf6cea46e2079c13332fa0ae520d52d.tar.bz2
Merge branch 'pr/2' into incoming
-rw-r--r--README.md11
1 files changed, 5 insertions, 6 deletions
diff --git a/README.md b/README.md
index d0fcac2..7977ab4 100644
--- a/README.md
+++ b/README.md
@@ -5,12 +5,14 @@ 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…
## 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.
```php
Hoa\Register\Registry::set('foo', 'bar');
@@ -26,9 +28,6 @@ var_dump(
*/
```
-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: