Skip to content

Commit 58f7447

Browse files
authored
Updated README
1 parent d745d07 commit 58f7447

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

README.md

+33-6
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
@@ -20,38 +20,65 @@ Dazzle Promise is a component that provides PHP implementation of promises speci
2020

2121
## Feature Highlights
2222

23-
Promise features:
23+
Dazzle Promise features:
2424

2525
* Implementation of promises,
2626
* Methods to resolve, reject or cancel promises,
2727
* Cancellation of promises using forget semantics,
2828
* Methods to join, map, race, reduce and do other things with set of promises,
2929
* ...and more.
3030

31+
## Provided Example(s)
32+
33+
### Quickstart
34+
35+
TODO
36+
37+
### Additional
38+
39+
TODO
40+
3141
## Requirements
3242

43+
Dazzle Promise requires:
44+
3345
* PHP-5.6 or PHP-7.0+,
3446
* UNIX or Windows OS.
3547

3648
## Installation
3749

50+
To install this library make sure you have [composer](https://getcomposer.org/) installed, then run following command:
51+
3852
```
3953
$> composer require dazzle-php/promise
4054
```
4155

4256
## Tests
4357

58+
Tests can be run via:
59+
4460
```
4561
$> vendor/bin/phpunit -d memory_limit=1024M
4662
```
4763

64+
## Versioning
65+
66+
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.
67+
4868
## Contributing
4969

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

5277
## License
5378

54-
Dazzle Framework is open-sourced software licensed under the [MIT license][2].
79+
Dazzle Framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
5580

56-
[1]: https://github.com/dazzle-php/promise/blob/master/CONTRIBUTING.md
57-
[2]: http://opensource.org/licenses/MIT
81+
<hr>
82+
<p align="center">
83+
<i>"Everything is possible. The impossible just takes longer."</i> ― Dan Brown
84+
</p>

0 commit comments

Comments
 (0)