Add a README file

Author: DEVizzent

README.md

@@ -0,0 +1,88 @@
+# Codecetion-MockServer Helper
+This library is a Module for [Codeception](https://codeception.com/) which allows your tests interact with 
+[mock-server](https://www.mock-server.com/)(v5) in an easy and intuitive way.
+
+MockServer allows you to simulate http services in your testing/local environment and this helper allows you check all 
+the request you have sent to mock server and manage the expectations of mockserver. 
+
+## How to use it
+
+#### WIP
+Write some code examples.
+
+## Installation
+
+Install the latest version with
+
+```bash
+$ composer require devizzent/codeception-mockserver-helper --dev
+```
+
+## Codeception Configuration
+Go to your codeception configuration and add this module
+```yaml
+modules:
+  enabled:
+    - DEVizzent\CodeceptionMockServerHelper\MockServerHelper:
+        ##Mandatory field, mock server url
+        url: 'http://mockserver:1080' 
+        ## Optional field, [test, suite, never] allowed. Default: test
+        cleanupBefore: 'test'
+        ## Optional field, [enabled, disabled] allowed. Default: enabled
+        notMatchedRequest: 'enabled' 
+```
+
+### cleanupBefore
+
+This variable set the moment when we want to clean the mockserver logs in order to don't affect the other tests or suites.
+We recomend set this value in the default value.
+ - 'test' will remove all logs before start any test making sure that you are not affected by request did in the previous
+test execution.
+ - 'suite' will remove all logs before start a suite of tests.
+ - 'never' will not remove your mock-server logs. It can generate confusion and failures in your tests, because if 
+you check something was called X times, the number of times increase every time you run your tests. If you only check that
+a request was called, it could be called in the previous execution, but by error not in the current one.
+
+### notMatchedRequest
+
+When this option is enabled, it creates an expectation with lowest priority which match all the request haven't matched
+our expectations, returning a 500 error with a message `Request not matched by MockServer`.
+
+It allows us to validate all request our application do, are expected and we haven't change our communication with 
+external services.
+
+## About
+
+### Requirements
+
+Codecetion-MockServer Helper needs at least php 7.4 or higher and codeception 4 or higher.
+
+### How to contribute
+
+Create an issue describing the bug or the new feature, create your fork of this project and send your PR.
+
+For using the dev environment you only need Docker, Docker-compose and Makefile.
+```text
+Usage:
+  make <target>
+
+Targets:
+  help                       Display this help
+  install                    Install required software and initialize your local configuration
+  up                         Start application containers and required services
+  debug                      Start application containers and required services in debug mode
+  down                       Stop application containers and required services
+  test                       Execute all phpunit test
+  composer-update            Run composer update
+  composer-install           Run composer update
+
+```
+
+### Author
+
+Vicent Valls - <vizzent@gmail.com> - <https://twitter.com/ViMalaBarraka><https://www.youtube.com/@DEVizzent><br />
+See also the list of [contributors](https://github.com/DEVizzent/codeception-mockserver-helper/graphs/contributors) who participated in this project.
+
+### License
+
+Codecetion-MockServer Helper is licensed under the MIT License - see the [LICENSE](LICENSE) file for details