From 6d9b113c0346bd471f918b1d124803bd30d777f2 Mon Sep 17 00:00:00 2001 From: Nigel Greenway Date: Thu, 26 Feb 2015 21:43:17 +0000 Subject: [PATCH] Add README file --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b7881b0 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# demander + +[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md) +[![Build Status](https://img.shields.io/travis/nigelgreenway/demander/master.svg?style=flat-square)](https://travis-ci.org/nigelgreenway/demander) + +This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what +PSRs you support to avoid any confusion with users and contributors. + +## Install + +Via Composer + +``` bash +$ composer require league/demander +``` + +## Usage + +Below is a very basic example on how to use the package. More docs will be released when version 1.0 is released in the next week or two. + +``` php + +$mapping = [ + 'GetActiveEmployeesQuery' => 'GetActiveEmployeesQueryHandler', +]; + +$mediator = new NigelGreenway\Demander($mapping); + +$activeEmployees = $mediator->request(new GetEmployeesByStatusQuery('active')); + +foreach($activeEmployees as $activeEmployee) { + echo $activeEmployee->fullName; +} + + +``` + +## Testing + +``` bash +$ phpunit +``` + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +## Security + +If you discover any security related issues, please email nigel_greenway@me.com instead of using the issue tracker. + +## Credits + +- [Nigel Greenway](https://github.com/NigelGreenway) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. \ No newline at end of file