Skip to content
This repository was archived by the owner on Sep 20, 2021. It is now read-only.

Commit b88ebbc

Browse files
committed
Documentation: New README.md file.
1 parent a448815 commit b88ebbc

1 file changed

Lines changed: 86 additions & 21 deletions

File tree

README.md

Lines changed: 86 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
1-
![Hoa](http://static.hoa-project.net/Image/Hoa_small.png)
2-
3-
Hoa is a **modular**, **extensible** and **structured** set of PHP libraries.
4-
Moreover, Hoa aims at being a bridge between industrial and research worlds.
5-
6-
# Hoa\Socket ![state](http://central.hoa-project.net/State/Socket)
1+
<p align="center">
2+
<img src="https://static.hoa-project.net/Image/Hoa.svg" alt="Hoa" width="250px" />
3+
</p>
4+
5+
---
6+
7+
<p align="center">
8+
<a href="https://travis-ci.org/hoaproject/socket"><img src="https://img.shields.io/travis/hoaproject/socket/master.svg" alt="Build status" /></a>
9+
<a href="https://coveralls.io/github/hoaproject/socket?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/socket/master.svg" alt="Code coverage" /></a>
10+
<a href="https://packagist.org/packages/hoa/socket"><img src="https://img.shields.io/packagist/dt/hoa/socket.svg" alt="Packagist" /></a>
11+
<a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/socket.svg" alt="License" /></a>
12+
</p>
13+
<p align="center">
14+
Hoa is a <strong>modular</strong>, <strong>extensible</strong> and
15+
<strong>structured</strong> set of PHP libraries.<br />
16+
Moreover, Hoa aims at being a bridge between industrial and research worlds.
17+
</p>
18+
19+
# Hoa\Socket
20+
21+
[![Help on IRC](https://img.shields.io/badge/help-%23hoaproject-ff0066.svg)](https://webchat.freenode.net/?channels=#hoaproject)
22+
[![Help on Gitter](https://img.shields.io/badge/help-gitter-ff0066.svg)](https://gitter.im/hoaproject/central)
23+
[![Documentation](https://img.shields.io/badge/documentation-hack_book-ff0066.svg)](https://central.hoa-project.net/Documentation/Library/Socket)
24+
[![Board](https://img.shields.io/badge/organisation-board-ff0066.svg)](https://waffle.io/hoaproject/socket)
725

826
This library provides an abstract layer to build safe, fast and modular clients
927
and servers.
@@ -15,22 +33,37 @@ encryption, remote informations etc. Such a connection, along with an abstract
1533
connection handler, allows to embed and “merge” many connections inside the same
1634
processus side-by-side.
1735

36+
[Learn more](https://central.hoa-project.net/Documentation/Library/Socket).
37+
1838
## Installation
1939

20-
With [Composer](http://getcomposer.org/), to include this library into your
21-
dependencies, you need to require
22-
[`hoa/socket`](https://packagist.org/packages/hoa/socket):
40+
With [Composer](https://getcomposer.org/), to include this library into
41+
your dependencies, you need to
42+
require [`hoa/socket`](https://packagist.org/packages/hoa/socket):
2343

24-
```json
25-
{
26-
"require": {
27-
"hoa/socket": "~1.0"
28-
}
29-
}
44+
```sh
45+
$ composer require hoa/socket '~1.0'
46+
```
47+
48+
For more installation procedures, please read [the Source
49+
page](https://hoa-project.net/Source.html).
50+
51+
## Testing
52+
53+
Before running the test suites, the development dependencies must be installed:
54+
55+
```sh
56+
$ composer install
57+
```
58+
59+
Then, to run all the test suites:
60+
61+
```sh
62+
$ vendor/bin/hoa test:run
3063
```
3164

32-
Please, read the website to [get more informations about how to
33-
install](http://hoa-project.net/Source.html).
65+
For more information, please read the [contributor
66+
guide](https://hoa-project.net/Literature/Contributor/Guide.html).
3467

3568
## Quick usage
3669

@@ -261,10 +294,42 @@ classes.
261294

262295
## Documentation
263296

264-
Different documentations can be found on the website:
265-
[http://hoa-project.net/](http://hoa-project.net/).
297+
The
298+
[hack book of `Hoa\Socket`](https://central.hoa-project.net/Documentation/Library/Socket) contains
299+
detailed information about how to use this library and how it works.
300+
301+
To generate the documentation locally, execute the following commands:
302+
303+
```sh
304+
$ composer require --dev hoa/devtools
305+
$ vendor/bin/hoa devtools:documentation --open
306+
```
307+
308+
More documentation can be found on the project's website:
309+
[hoa-project.net](https://hoa-project.net/).
310+
311+
## Getting help
312+
313+
There are mainly two ways to get help:
314+
315+
* On the [`#hoaproject`](https://webchat.freenode.net/?channels=#hoaproject)
316+
IRC channel,
317+
* On the forum at [users.hoa-project.net](https://users.hoa-project.net).
318+
319+
## Contribution
320+
321+
Do you want to contribute? Thanks! A detailed [contributor
322+
guide](https://hoa-project.net/Literature/Contributor/Guide.html) explains
323+
everything you need to know.
266324

267325
## License
268326

269-
Hoa is under the New BSD License (BSD-3-Clause). Please, see
270-
[`LICENSE`](http://hoa-project.net/LICENSE).
327+
Hoa is under the New BSD License (BSD-3-Clause). Please, see
328+
[`LICENSE`](https://hoa-project.net/LICENSE) for details.
329+
330+
## Related projects
331+
332+
The following projects are using this library:
333+
334+
* [PHP School](https://www.phpschool.io/), A revolutionary new way
335+
to learn PHP.

0 commit comments

Comments
 (0)