Skip to content

Commit 916644e

Browse files
Update Readme
1 parent a52352f commit 916644e

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,47 @@ See the [documentation](http://www.ethanhann.com/redisearch-php/) for more infor
1515

1616
Contributions are welcome. Before submitting a PR for review, please run confirm all tests in the test suite pass.
1717

18-
Start the local dev environment by running:
18+
Start the local Docker dev environment by running:
1919

20-
```docker compose up```
20+
```shell
21+
docker compose up
22+
```
2123

2224
...or simply:
2325

24-
```./dev```
26+
```shell
27+
./dev
28+
```
2529

2630
Then run the tests:
2731

28-
```./vendor/bin/phpunit```
32+
```shell
33+
vendor/bin/robo test
34+
```
35+
36+
Specific Redis clients can be tested:
37+
38+
```shell
39+
vendor/bin/robo test:predis
40+
vendor/bin/robo test:php-redis
41+
vendor/bin/robo test:redis-client
42+
```
43+
44+
Or to run tests for all clients:
45+
46+
```shell
47+
vendor/bin/robo test:all
48+
```
2949

3050
Do not run tests on a prod system (of course), or any system that has a Redis instance with data you care about -
3151
Redis is flushed between tests.
3252

53+
To fix code style, before submitting a PR:
54+
55+
```shell
56+
vendor/bin/robo task:fix-code-style
57+
```
58+
3359
**Laravel Support**
3460

3561
[Laravel-RediSearch](https://github.com/ethanhann/Laravel-RediSearch) - Exposes RediSearch-PHP to Laravel as a Scout driver.

0 commit comments

Comments
 (0)