From 57fd1f9da75547cf0f658f01f4510fbe1ae68903 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Tue, 5 Jan 2021 23:49:40 -0500 Subject: [PATCH] Improve project description --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ca4023a..83f084c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ # Codeception Symfony Module Tests + +[![Actions Status](https://github.com/Codeception/symfony-module-tests/workflows/CI/badge.svg)](https://github.com/Codeception/symfony-module-tests/actions) + Minimal site containing functional tests for [Codeception Module Symfony](https://github.com/Codeception/module-symfony). -## Installation +## Usage + +The main purpose of this project is to verify the proper functioning of the `Codeception Module Symfony` in a minimal Symfony installation. + +You can use it to contribute new features or propose changes in the module and verify that nothing is broken in the process. +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. + +You can also **fork it** and use it to reproduce a bug or unexpected behavior for analysis. +If that's your case, just add a link to your fork next to the description of your issue in the module's repository. + +Lastly, if you just want to see the module in action and run the tests yourself on your local machine just: 1. Clone the repo ```shell @@ -18,7 +31,7 @@ Minimal site containing functional tests for [Codeception Module Symfony](https: php bin/console doctrine:fixtures:load --quiet ``` -## Usage +Then, go to the project directory and run: ```shell vendor/bin/codecept run Functional