aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 17:20:46 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 17:20:46 +0200
commitc992619a1fa80f7007a64f77c2d1979ba0ec0614 (patch)
tree25b114fcad30056e414967e613e4a8fd20f43165
parent747881d08c7bb4a6d6bc22bbe83d1f8613f721e9 (diff)
downloadUstring-c992619a1fa80f7007a64f77c2d1979ba0ec0614.zip
Ustring-c992619a1fa80f7007a64f77c2d1979ba0ec0614.tar.gz
Ustring-c992619a1fa80f7007a64f77c2d1979ba0ec0614.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 a64c0a2..38ce1bd 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 allows to manipulate UTF-8 strings easily with some search
algorithms.
+## Installation
+
+With [Composer](http://getcomposer.org/), to include this library into your
+dependencies, you need to require
+[`hoa/string`](https://packagist.org/packages/hoa/string):
+
+```json
+{
+ "require": {
+ "hoa/string": "~2.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 two usages: manipulate UTF-8 strings and one