aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2016-10-14 23:47:22 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2016-10-14 23:47:22 +0200
commit5c6d8cd3784e27d5e6358ece65dfc6180079bedf (patch)
tree368408c4f0e061ad3e13405d65304da38e6eef47
parenteeab466c7321360ee67196525f205609510d72b6 (diff)
downloadWebsocket-5c6d8cd3784e27d5e6358ece65dfc6180079bedf.zip
Websocket-5c6d8cd3784e27d5e6358ece65dfc6180079bedf.tar.gz
Websocket-5c6d8cd3784e27d5e6358ece65dfc6180079bedf.tar.bz2
Documentation: New `README.md` file.
-rw-r--r--README.md111
1 files changed, 89 insertions, 22 deletions
diff --git a/README.md b/README.md
index 92934dd..5d7df0d 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,27 @@
-![Hoa](http://static.hoa-project.net/Image/Hoa_small.png)
-
-Hoa is a **modular**, **extensible** and **structured** set of PHP libraries.
-Moreover, Hoa aims at being a bridge between industrial and research worlds.
-
-# Hoa\Websocket ![state](http://central.hoa-project.net/State/Websocket)
+<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/websocket"><img src="https://img.shields.io/travis/hoaproject/websocket/master.svg" alt="Build status" /></a>
+ <a href="https://coveralls.io/github/hoaproject/websocket?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/websocket/master.svg" alt="Code coverage" /></a>
+ <a href="https://packagist.org/packages/hoa/websocket"><img src="https://img.shields.io/packagist/dt/hoa/websocket.svg" alt="Packagist" /></a>
+ <a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/websocket.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\Websocket
+
+[![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)
+[![Documentation](https://img.shields.io/badge/documentation-hack_book-ff0066.svg)](https://central.hoa-project.net/Documentation/Library/Websocket)
+[![Board](https://img.shields.io/badge/organisation-board-ff0066.svg)](https://waffle.io/hoaproject/websocket)
This library allows to manipulate the WebSocket protocol and proposes a server
and a client. It supports two specifications
@@ -11,22 +29,37 @@ and a client. It supports two specifications
[Hybi](https://tools.ietf.org/wg/hybi/draft-ietf-hybi-thewebsocketprotocol/) (at
the same time).
+[Learn more](https://central.hoa-project.net/Documentation/Library/Websocket).
+
## Installation
-With [Composer](http://getcomposer.org/), to include this library into your
-dependencies, you need to require
-[`hoa/websocket`](https://packagist.org/packages/hoa/websocket):
+With [Composer](https://getcomposer.org/), to include this library into
+your dependencies, you need to
+require [`hoa/websocket`](https://packagist.org/packages/hoa/websocket):
+
+```sh
+$ composer require hoa/websocket '~2.0'
+```
+
+For more installation procedures, please read [the Source
+page](https://hoa-project.net/Source.html).
-```json
-{
- "require": {
- "hoa/websocket": "~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
@@ -129,16 +162,50 @@ Here we are. All sent messages are echoed.
The following awecodes show this library in action:
- * [`Hoa\Websocket`](http://hoa-project.net/Awecode/Websocket.html):
+ * [`Hoa\Websocket`](https://hoa-project.net/Awecode/Websocket.html):
*why and how to use `Hoa\Websocket\Server` and `Hoa\Websocket\Client`? A
simple example will illustrate the WebSocket protocol*.
## Documentation
-Different documentations can be found on the website:
-[http://hoa-project.net/](http://hoa-project.net/).
+The
+[hack book of `Hoa\Websocket`](https://central.hoa-project.net/Documentation/Library/Websocket) 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:
+
+ * [Marvirc](https://github.com/Hywan/Marvirc), A dead simple,
+ extremely modular and blazing fast IRC bot,
+ * [WellCommerce](http://wellcommerce.org/), Modern e-commerce engine
+ built on top of Symfony 3 full-stack framework.