Skip to content

Commit 5b62d9a

Browse files
authored
Updated README
1 parent 953d4f0 commit 5b62d9a

1 file changed

Lines changed: 33 additions & 5 deletions

File tree

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
1212
<br>
1313
<p align="center">
14-
<img src="https://avatars0.githubusercontent.com/u/29509136?v=3&s=150" />
14+
<img src="https://raw.githubusercontent.com/dazzle-php/dazzle/master/media/dazzle-x125.png" />
1515
</p>
1616

1717
## Description
@@ -26,30 +26,58 @@ Dazzle Socket features:
2626
* Support for TCP, UDP and Unix sockets,
2727
* ...and more.
2828

29+
## Provided Example(s)
30+
31+
### Quickstart
32+
33+
TODO
34+
35+
### Additional
36+
37+
TODO
38+
2939
## Requirements
3040

41+
Dazzle Socket requires:
42+
3143
* PHP-5.6 or PHP-7.0+,
3244
* UNIX or Windows OS.
3345

3446
## Installation
3547

48+
To install this library make sure you have [composer](https://getcomposer.org/) installed, then run following command:
49+
3650
```
3751
$> composer require dazzle-php/socket
3852
```
3953

4054
## Tests
4155

56+
Tests can be run via:
57+
4258
```
4359
$> vendor/bin/phpunit -d memory_limit=1024M
4460
```
4561

62+
## Versioning
63+
64+
Versioning of Dazzle libraries is being shared between all packages included in [Dazzle Project](https://github.com/dazzle-php/dazzle). That means the releases are being made concurrently for all of them. On one hand this might lead to "empty" releases for some packages at times, but don't worry. In the end it is far much easier for contributors to maintain and -- what's the most important -- much more straight-forward for users to understand the compatibility and inter-operability of the packages.
65+
4666
## Contributing
4767

48-
Thank you for considering contributing to this repository! The contribution guide can be found in the [contribution tips][1].
68+
Thank you for considering contributing to this repository!
69+
70+
- The contribution guide can be found in the [contribution tips](https://github.com/dazzle-php/socket/blob/master/CONTRIBUTING.md).
71+
- Open tickets can be found in [issues section](https://github.com/dazzle-php/socket/issues).
72+
- Current contributors are listed in [graphs section](https://github.com/dazzle-php/socket/graphs/contributors)
73+
- To contact the author(s) see the information attached in [composer.json](https://github.com/dazzle-php/socket/blob/master/composer.json) file.
4974

5075
## License
5176

52-
Dazzle Framework is open-sourced software licensed under the [MIT license][2].
77+
Dazzle Socket is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
78+
79+
<hr>
80+
<p align="center">
81+
<i>"Everything is possible. The impossible just takes longer."</i> ― Dan Brown
82+
</p>
5383

54-
[1]: https://github.com/dazzle-php/socket/blob/master/CONTRIBUTING.md
55-
[2]: http://opensource.org/licenses/MIT

0 commit comments

Comments
 (0)