From 7f243dee3d928f69eb6836332e8d48fc89588dbd Mon Sep 17 00:00:00 2001 From: Oshomo Oforomeh Date: Tue, 5 Sep 2017 16:37:37 +0100 Subject: [PATCH] Updated README --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 740f42e..43e8398 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,9 @@ ### How to run -From the package root, run assignment using php built in server `php -S localhost:8000`, this would start the server at `localhost:8000`. Visit the URL from your browser and you should see the generated files at the root of the package. +From the package root, run `composer install` then using php built in server run `php -S localhost:8000`, this would start the server at `localhost:8000`. Visit the URL from your browser and you should see the generated files at the root of the package. The `sample.csv` is at the root of the package. Generated files would also be saved there. -To run test make sure you have `PHPUNIT` installed on the test machine. Then run `phpunit` also from the root of the Package. - ### Implementation The `CsvConverter` and `CsvValidator` were written in isolation of each other so, that they can be used seperately if need arise. The `CsvConverter` expects a valid file path and an array of validation rule(s) and in turn an array of all, valid and invalid data can be accessed. @@ -171,6 +169,10 @@ header('Content-Type: application/xml'); print($converter->toXml()); ``` +### Running Test's + +Run `phpunit` from the root of the Package. This assumes you have ran `composer install`. + ### Todo's - Support for more validation rules `string`, `number`, `date`, `required`, `boolean`, `email`, `phone_number`, `ip_address`