Put a one-line description of your project here.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
Give examples
A step by step series of examples that tell you have to get a development env running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
The test suite may be run locally by way of some simple composer scripts.
| Test | Command |
|---|---|
| Run all tests | composer test |
| PHPUnit tests | composer unit |
| PHP linter | composer lint |
| Code style | composer cs |
| Fix style errors | composer cbf |
Add additional notes about how to deploy this on a live system
- Composer - Dependency Management
Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Greg Anderson - created project from template.
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone who's code was used
- Inspiration
- etc
- Thanks to PurpleBooth for the example README template