Skip to content

Commit f5a3f49

Browse files
authored
[6.x] Improve project description (#2)
1 parent 140c41c commit f5a3f49

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@
44

55
Minimal site containing functional tests for [Codeception Module Laravel](https://github.com/Codeception/module-laravel).
66

7-
## Installation
7+
## Usage
8+
9+
The main purpose of this project is to verify the proper functioning of the `Codeception Module Laravel` in a minimal Laravel installation.
10+
11+
You can use it to contribute new features or propose changes in the module and verify that nothing is broken in the process.
12+
If that's your goal, be sure to follow [the contribution guides](https://github.com/Codeception/module-laravel/blob/main/CONTRIBUTING.md) for the module.
13+
14+
You can also **fork it** and use it to reproduce a bug or unexpected behavior for analysis.
15+
If that's your case, just add a link to your fork next to the description of your issue in the module's repository.
16+
17+
Lastly, if you just want to see the module in action and run the tests yourself on your local machine just:
818

919
1. Clone the repo:
1020
```shell
@@ -21,7 +31,7 @@ Minimal site containing functional tests for [Codeception Module Laravel](https:
2131
php artisan migrate --seed
2232
```
2333

24-
## Usage
34+
Then, go to the project directory and run:
2535

2636
```shell
2737
vendor/bin/codecept run Functional

0 commit comments

Comments
 (0)