aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 16:57:53 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 16:57:53 +0200
commit8527127a771e82b42542aabde07cb9993c7d3c82 (patch)
tree53283fa3bbd3e6849466aed2fd5d6816b1eaea2e
parent7e9715bc092ec9d93b03bf242476a9c5bc8afafc (diff)
downloadIterator-8527127a771e82b42542aabde07cb9993c7d3c82.zip
Iterator-8527127a771e82b42542aabde07cb9993c7d3c82.tar.gz
Iterator-8527127a771e82b42542aabde07cb9993c7d3c82.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 db59830..ff3857c 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,23 @@ This library provides a set of useful iterator (compatible with PHP iterators).
Existing PHP iterators have been updated to get new features and prior PHP
versions compatibility.
+## Installation
+
+With [Composer](http://getcomposer.org/), to include this library into your
+dependencies, you need to require
+[`hoa/iterator`](https://packagist.org/packages/hoa/iterator):
+
+```json
+{
+ "require": {
+ "hoa/iterator": "~0.0"
+ }
+}
+```
+
+Please, read the website to [get more informations about how to
+install](http://hoa-project.net/Source.html).
+
## Quick usage
We propose a quick overview of the list all iterators.