diff options
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2016-10-18 16:47:53 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2016-10-18 16:50:57 +0200
commit9e253ca3a7646c00c354a7fffa4cefc75f1cb512 (patch)
parentb820cef7fbc6e3489a13f64317951e9ae179651e (diff)
Documentation: New `README.md` file.
1 files changed, 79 insertions, 21 deletions
diff --git a/README.md b/README.md
index d57f83a..bae43f7 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,27 @@
-Hoa is a **modular**, **extensible** and **structured** set of PHP libraries.
-Moreover, Hoa aims at being a bridge between industrial and research worlds.
-# Hoa\Mail ![state](http://central.hoa-project.net/State/Mail)
+<p align="center">
+ <img src="https://static.hoa-project.net/Image/Hoa.svg" alt="Hoa" width="250px" />
+<p align="center">
+ <a href="https://travis-ci.org/hoaproject/mail"><img src="https://img.shields.io/travis/hoaproject/mail/master.svg" alt="Build status" /></a>
+ <a href="https://coveralls.io/github/hoaproject/mail?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/mail/master.svg" alt="Code coverage" /></a>
+ <a href="https://packagist.org/packages/hoa/mail"><img src="https://img.shields.io/packagist/dt/hoa/mail.svg" alt="Packagist" /></a>
+ <a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/mail.svg" alt="License" /></a>
+<p align="center">
+ Hoa is a <strong>modular</strong>, <strong>extensible</strong> and
+ <strong>structured</strong> set of PHP libraries.<br />
+ Moreover, Hoa aims at being a bridge between industrial and research worlds.
+# Hoa\Mail
+[![Help on IRC](https://img.shields.io/badge/help-%23hoaproject-ff0066.svg)](https://webchat.freenode.net/?channels=#hoaproject)
+[![Help on Gitter](https://img.shields.io/badge/help-gitter-ff0066.svg)](https://gitter.im/hoaproject/central)
This library allows to compose and send rich emails (textual contents, HTML
documents, alternative contents, attachments etc., this is very extensible).
@@ -12,22 +30,37 @@ 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.
+[Learn more](https://central.hoa-project.net/Documentation/Library/Mail).
## Installation
-With [Composer](http://getcomposer.org/), to include this library into your
-dependencies, you need to require
+With [Composer](https://getcomposer.org/), to include this library into
+your dependencies, you need to
+require [`hoa/mail`](https://packagist.org/packages/hoa/mail):
+$ composer require hoa/mail '~0.0'
+For more installation procedures, please read [the Source
+## Testing
+Before running the mail suites, the development dependencies must be installed:
+$ composer install
+Then, to run all the test suites:
- "require": {
- "hoa/mail": "~0.0"
- }
+$ vendor/bin/hoa test:run
-Please, read the website to [get more informations about how to
+For more information, please read the [contributor
## Quick usage
@@ -143,10 +176,35 @@ $message->addContent(
## Documentation
-Different documentations can be found on the website:
+[hack book of `Hoa\Mail`](https://central.hoa-project.net/Documentation/Library/Mail) contains
+detailed information about how to use this library and how it works.
+To generate the documentation locally, execute the following commands:
+$ composer require --dev hoa/devtools
+$ vendor/bin/hoa devtools:documentation --open
+More documentation can be found on the project's website:
+## Getting help
+There are mainly two ways to get help:
+ * On the [`#hoaproject`](https://webchat.freenode.net/?channels=#hoaproject)
+ IRC channel,
+ * On the forum at [users.hoa-project.net](https://users.hoa-project.net).
+## Contribution
+Do you want to contribute? Thanks! A detailed [contributor
+guide](https://hoa-project.net/Literature/Contributor/Guide.html) explains
+everything you need to know.
## License
-Hoa is under the New BSD License (BSD-3-Clause). Please, see
+Hoa is under the New BSD License (BSD-3-Clause). Please, see
+[`LICENSE`](https://hoa-project.net/LICENSE) for details.