Skip to content

Commit d90478b

Browse files
authored
[main] Improve project description (#7)
1 parent 61982f1 commit d90478b

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
# Codeception Symfony Module Tests
2+
3+
[![Actions Status](https://github.com/Codeception/symfony-module-tests/workflows/CI/badge.svg)](https://github.com/Codeception/symfony-module-tests/actions)
4+
25
Minimal site containing functional tests for [Codeception Module Symfony](https://github.com/Codeception/module-symfony).
36

4-
## Installation
7+
## Usage
8+
9+
The main purpose of this project is to verify the proper functioning of the `Codeception Module Symfony` in a minimal Symfony 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-symfony/blob/master/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:
518

619
1. Clone the repo
720
```shell
@@ -18,7 +31,7 @@ Minimal site containing functional tests for [Codeception Module Symfony](https:
1831
php bin/console doctrine:fixtures:load --quiet
1932
```
2033

21-
## Usage
34+
Then, go to the project directory and run:
2235

2336
```shell
2437
vendor/bin/codecept run Functional

0 commit comments

Comments
 (0)