Skip to content

Commit 7892996

Browse files
committed
docs: Update README
1 parent c5b4294 commit 7892996

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A lightweight implementation of [CommonJS Promises/A][CommonJS Promises/A] for P
66
> This is a fork of [reactphp/promise][reactphp/promise] with the following improvements:
77
> - PHP 8.1+ compatibility
88
> - `declare(strict_types=1);` in all files
9-
> - `@yield` annotations in promise interfaces
9+
> - `@yield` annotation in the PromiseInterface
1010
> - Enhanced type annotations
1111
> - Replaces `react/promise` v2
1212
@@ -23,6 +23,20 @@ composer require internal/promise
2323
[![License](https://img.shields.io/packagist/l/internal/promise.svg?style=flat-square)](LICENSE.md)
2424
[![Total Downloads](https://img.shields.io/packagist/dt/internal/promise.svg?style=flat-square)](https://packagist.org/packages/buggregator/trap)
2525

26+
## Tests
27+
28+
To run the test suite, go to the project root and run:
29+
30+
```bash
31+
composer test
32+
```
33+
34+
On top of this, Psalm is used to ensure type safety across the project:
35+
36+
```bash
37+
composer psalm
38+
```
39+
2640
## Credits
2741

2842
This fork is based on [reactphp/promise][reactphp/promise], which is a port of [when.js][when.js]

0 commit comments

Comments
 (0)