You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -20,38 +20,65 @@ Dazzle Promise is a component that provides PHP implementation of promises speci
20
20
21
21
## Feature Highlights
22
22
23
-
Promise features:
23
+
Dazzle Promise features:
24
24
25
25
* Implementation of promises,
26
26
* Methods to resolve, reject or cancel promises,
27
27
* Cancellation of promises using forget semantics,
28
28
* Methods to join, map, race, reduce and do other things with set of promises,
29
29
* ...and more.
30
30
31
+
## Provided Example(s)
32
+
33
+
### Quickstart
34
+
35
+
TODO
36
+
37
+
### Additional
38
+
39
+
TODO
40
+
31
41
## Requirements
32
42
43
+
Dazzle Promise requires:
44
+
33
45
* PHP-5.6 or PHP-7.0+,
34
46
* UNIX or Windows OS.
35
47
36
48
## Installation
37
49
50
+
To install this library make sure you have [composer](https://getcomposer.org/) installed, then run following command:
51
+
38
52
```
39
53
$> composer require dazzle-php/promise
40
54
```
41
55
42
56
## Tests
43
57
58
+
Tests can be run via:
59
+
44
60
```
45
61
$> vendor/bin/phpunit -d memory_limit=1024M
46
62
```
47
63
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
+
48
68
## Contributing
49
69
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.
51
76
52
77
## License
53
78
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).
0 commit comments