aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 17:27:35 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 17:27:35 +0200
commit6b58e81da49c426599fd0925fe51425e0fcab531 (patch)
tree7e669fdfcecabbbc972a207b432c05256c6e1b45
parent6129185027c398819c02d101c3e85540d9eecd5a (diff)
downloadRegistry-6b58e81da49c426599fd0925fe51425e0fcab531.zip
Registry-6b58e81da49c426599fd0925fe51425e0fcab531.tar.gz
Registry-6b58e81da49c426599fd0925fe51425e0fcab531.tar.bz2
Add the installation section.
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7977ab4..18af56e 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,23 @@ Moreover, Hoa aims at being a bridge between industrial and research worlds.
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…
+## Installation
+
+With [Composer](http://getcomposer.org/), to include this library into your
+dependencies, you need to require
+[`hoa/registry`](https://packagist.org/packages/hoa/registry):
+
+```json
+{
+ "require": {
+ "hoa/registry": "~2.0"
+ }
+}
+```
+
+Please, read the website to [get more informations about how to
+install](http://hoa-project.net/Source.html).
+
## Quick usage
As a quick example, we set an entry and retrieve it. The retrieval can be done