aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2013-07-01 15:47:30 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2013-07-01 15:47:30 +0200
commit71165a93d11ea806c51d93fcdd2d509393c53f2d (patch)
tree80530c67bae4c7248196c0bb4b97a4d467798e8b
parent97c92872054389e3f960bdb31180ac53cf9091cf (diff)
downloadRegistry-71165a93d11ea806c51d93fcdd2d509393c53f2d.zip
Registry-71165a93d11ea806c51d93fcdd2d509393c53f2d.tar.gz
Registry-71165a93d11ea806c51d93fcdd2d509393c53f2d.tar.bz2
Add the README.md.
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3cb618
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+![Hoa](http://static.hoa-project.net/Image/Hoa_small.png)
+
+Hoa is a **modular**, **extensible** and **structured** set of PHP libraries.
+Moreover, Hoa aims at being a bridge between industrial and research worlds.
+
+# Hoa\Registry
+
+This library proposes a static register with facilities.
+
+## Quick usage
+
+As a quick overview, we propose to set an entry and retrieve it from the
+`hoa://` protocol:
+
+ Hoa\Register::set('foo', 'bar');
+ var_dump(
+ Hoa\Registry::get('foo'),
+ resolve('hoa://Library/Registry#foo')
+ );
+
+ /**
+ * Will output:
+ * string(3) "bar"
+ * 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:
+[http://hoa-project.net/](http://hoa-project.net/).
+
+## License
+
+Hoa is under the New BSD License (BSD-3-Clause). Please, see
+[`LICENSE`](http://hoa-project.net/LICENSE).