diff options
author | Ivan Enderlin <ivan.enderlin@hoa-project.net> | 2016-10-18 15:59:19 +0200 |
---|---|---|
committer | Ivan Enderlin <ivan.enderlin@hoa-project.net> | 2016-10-18 15:59:19 +0200 |
commit | b485b9d9f8a44e102a5b1ff5d642db128d6ac036 (patch) | |
tree | 2a9f7c48cf90278607886f62a20e5792db90e772 | |
parent | 0d2e357352880df0f504a90c52d93ab6fa48d634 (diff) | |
download | Dns-b485b9d9f8a44e102a5b1ff5d642db128d6ac036.zip Dns-b485b9d9f8a44e102a5b1ff5d642db128d6ac036.tar.gz Dns-b485b9d9f8a44e102a5b1ff5d642db128d6ac036.tar.bz2 |
Documentation: New `README.md` file.
-rw-r--r-- | README.md | 108 |
1 files changed, 87 insertions, 21 deletions
@@ -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  +<p align="center"> + <img src="https://static.hoa-project.net/Image/Hoa.svg" alt="Hoa" width="250px" /> +</p> + +--- + +<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> +<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. +</p> + +# Hoa\Dns + +[](https://webchat.freenode.net/?channels=#hoaproject) +[](https://gitter.im/hoaproject/central) +[](https://central.hoa-project.net/Documentation/Library/Dns) +[](https://waffle.io/hoaproject/dns) 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 -[`hoa/dns`](https://packagist.org/packages/hoa/dns): +With [Composer](https://getcomposer.org/), to include this library into +your dependencies, you need to +require [`hoa/dns`](https://packagist.org/packages/hoa/dns): + +```sh +$ composer require hoa/dns '~3.0' +``` + +For more installation procedures, please read [the Source +page](https://hoa-project.net/Source.html). -```json -{ - "require": { - "hoa/dns": "~3.0" - } -} +## Testing + +Before running the test suites, the development dependencies must be installed: + +```sh +$ composer install +``` + +Then, to run all the test suites: + +```sh +$ vendor/bin/hoa test:run ``` -Please, read the website to [get more informations about how to -install](http://hoa-project.net/Source.html). +For more information, please read the [contributor +guide](https://hoa-project.net/Literature/Contributor/Guide.html). ## Quick usage @@ -117,10 +150,43 @@ We see that `foo.hoa` is resolved to `127.0.0.1`! ## Documentation -Different documentations can be found on the website: -[http://hoa-project.net/](http://hoa-project.net/). +The +[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: + +```sh +$ composer require --dev hoa/devtools +$ vendor/bin/hoa devtools:documentation --open +``` + +More documentation can be found on the project's website: +[hoa-project.net](https://hoa-project.net/). + +## 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 -[`LICENSE`](http://hoa-project.net/LICENSE). +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. |