aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 17:53:41 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 17:53:41 +0200
commit89f5907960481c16f57fd990769e9824ff5cebdb (patch)
tree2fcdcf265fa94fc928eb1bfcfc15bbfd684f54ea
parent0c8be6a2b01f66da488e8459a383f32a9a42ddca (diff)
downloadEventsource-89f5907960481c16f57fd990769e9824ff5cebdb.zip
Eventsource-89f5907960481c16f57fd990769e9824ff5cebdb.tar.gz
Eventsource-89f5907960481c16f57fd990769e9824ff5cebdb.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 9d5699f..1b5bec7 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,23 @@ This library allows to manipulate the
[EventSource](http://w3.org/TR/eventsource/) (aka Server-Sent Events) technology
by creating a server.
+## Installation
+
+With [Composer](http://getcomposer.org/), to include this library into your
+dependencies, you need to require
+[`hoa/eventsource`](https://packagist.org/packages/hoa/eventsource):
+
+```json
+{
+ "require": {
+ "hoa/eventsource": "~2.0"
+ }
+}
+```
+
+Please, read the website to [get more informations about how to
+install](http://hoa-project.net/Source.html).
+
## Quick usage
We propose as a quick overview to send an unlimited number of events from the