diff --git a/README.md b/README.md index 97da201..7684690 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,75 @@ [![License](https://img.shields.io/github/license/tbreuss/pvc.svg)](https://github.com/tbreuss/pvc/blob/master/LICENSE) [![PHP from Packagist](https://img.shields.io/packagist/php-v/tebe/pvc.svg)](https://packagist.org/packages/tebe/pvc) -A minimal **P**[HP] [M]**VC** framework for refreshing OOP and learning new concepts in PHP. -Just for my own experimentation and without any expectations. +A minimal **P**[HP] [M]**VC** framework using well-tried concepts in PHP. -## Usage +## Prerequisites -Have a look at the example project at: - +- PHP 7.2 +- Composer + + +## Installation + +Composer is your friend. + + $ composer create-project tebe/pvc myproject + + +## Running + + $ cd myproject/example/public + $ php -S localhost:9999 + +Start your web browser and open + + +### Basic Auth Middleware + +The example is using some middlewares. + +For the Basic Auth middleware the Login details are: + + Username: user + Password: pass + +You're ready to go! + + +## Scripts + +#### Testing + +Start PHPUnit useing the following composer script. + + $ composer phpunit + +#### Codesniffer + +Start PHP Codesniffer: + + $ composer phpcs + +Fix Codesniffer issues: + + $ composer phpcbf + +#### Both together + + $ composer test + + +## Continues Integration + +PVC is using Travis () for Continuous Integration. + + +## License + +[MIT License](https://github.com/tbreuss/pvc/blob/master/LICENSE) + + +## Issues + +Any suggestions? Open an [issue](https://github.com/tbreuss/pvc/issues).