Skip to content

Commit

Permalink
馃摉 DOC: Enhance readme
Browse files Browse the repository at this point in the history
  • Loading branch information
elie29 committed Feb 21, 2019
1 parent 2a95701 commit 41b4b7a
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,6 @@
## Introduction
A library for validating a context (POST, GET etc...) by running given rules.

## Text file encoding
- UTF-8

## Code style formatter
- Zend Framework coding standard

## Composer commands
- `clean`: Clean all generated files
- `test`: Launch unit test
- `test-coverage`: Launch unit test with clover.xml file generation
- `cs-check`: code sniffer check
- `cs-fix`: code sniffer fix
- `phpstan`: Launch PHP Static Analysis Tool
- `check`: Launch `clean`, `cs-check`, `test` and `phpstan`

## Installation ##

Run the command below to install via Composer:
Expand Down Expand Up @@ -149,3 +134,21 @@ Assert::true($validator->validate(), $validator->getImplodedErrors());

Assertion::true($validator->validate(), $validator->getImplodedErrors());
```

## Development Prerequisites

### Text file encoding
- UTF-8

### Code style formatter
- Zend Framework coding standard

### Composer commands
- `clean`: Clean all generated files
- `test`: Launch unit test
- `test-coverage`: Launch unit test with clover.xml file generation
- `cs-check`: code sniffer check
- `cs-fix`: code sniffer fix
- `phpstan`: Launch PHP Static Analysis Tool
- `check`: Launch `clean`, `cs-check`, `test` and `phpstan`

0 comments on commit 41b4b7a

Please sign in to comment.