path: root/README.md
diff options
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2016-10-18 15:59:19 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2016-10-18 15:59:19 +0200
commitb485b9d9f8a44e102a5b1ff5d642db128d6ac036 (patch)
tree2a9f7c48cf90278607886f62a20e5792db90e772 /README.md
parent0d2e357352880df0f504a90c52d93ab6fa48d634 (diff)
Documentation: New `README.md` file.
Diffstat (limited to 'README.md')
1 files changed, 87 insertions, 21 deletions
diff --git a/README.md b/README.md
index 3be081a..0998c85 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,61 @@
-Hoa is a **modular**, **extensible** and **structured** set of PHP libraries.
-Moreover, Hoa aims at being a bridge between industrial and research worlds.
-# Hoa\Dns ![state](http://central.hoa-project.net/State/Dns)
+<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/dns"><img src="https://img.shields.io/travis/hoaproject/dns/master.svg" alt="Build status" /></a>
+ <a href="https://coveralls.io/github/hoaproject/dns?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/dns/master.svg" alt="Code coverage" /></a>
+ <a href="https://packagist.org/packages/hoa/dns"><img src="https://img.shields.io/packagist/dt/hoa/dns.svg" alt="Packagist" /></a>
+ <a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/dns.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\Dns
+[![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 create a domain name resolver.
+[Learn more](https://central.hoa-project.net/Documentation/Library/Dns).
## 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/dns`](https://packagist.org/packages/hoa/dns):
+$ composer require hoa/dns '~3.0'
+For more installation procedures, please read [the Source
- "require": {
- "hoa/dns": "~3.0"
- }
+## Testing
+Before running the test suites, the development dependencies must be installed:
+$ composer install
+Then, to run all the test suites:
+$ 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
@@ -117,10 +150,43 @@ We see that `foo.hoa` is resolved to ``!
## Documentation
-Different documentations can be found on the website:
+[hack book of `Hoa\Dns`](https://central.hoa-project.net/Documentation/Library/Dns) 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.
+## Related projects
+The following projects are using this library:
+ * [ec2dns](https://github.com/fruux/ec2dns), ec2dns is a set of
+ command line tools that makes it easy to display public hostnames
+ of EC2 instances and ssh into them via their tag name.