aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 18:04:29 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2014-09-17 18:04:29 +0200
commit451e0e5f0a6c693b50bbd73bb6caa883f0a1c422 (patch)
treed8dcd35281463357d8dff8d1fe78546ed4f21dfe /README.md
parentc7e00c14d941b499ada3b0c7f008293b55a24834 (diff)
downloadMail-451e0e5f0a6c693b50bbd73bb6caa883f0a1c422.zip
Mail-451e0e5f0a6c693b50bbd73bb6caa883f0a1c422.tar.gz
Mail-451e0e5f0a6c693b50bbd73bb6caa883f0a1c422.tar.bz2
Add the installation section.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index b491f7b..6384e2e 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,23 @@ Email can be sent with sendmail or SMTP. The SMTP layer supports TLS and
In a near future, this library will also allow to receive and parse emails.
+## Installation
+
+With [Composer](http://getcomposer.org/), to include this library into your
+dependencies, you need to require
+[`hoa/mail`](https://packagist.org/packages/hoa/mail):
+
+```json
+{
+ "require": {
+ "hoa/mail": "~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 to send a very simple email with only one content,