diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..f17846b --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing + +Please note the following guidelines before submitting pull requests: + +- Use the [PSR-2 coding style](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) +- Always create pull requests to the *develop* branch diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..dfc2d97 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ +### What did you do? + +### What did you expect to happen? + +### What actually happened? + +### What versions of PHP, Lumen and this module are you using? + +Please include code that reproduces the issue. The best reproductions are self-contained scripts with minimal dependencies. + +```php +code goes here +``` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..4e20706 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ +(Please read the [guidelines](.github/CONTRIBUTING.md) before creating PRs.) + +Fixes #. + +Changes proposed in this pull request: + * + * + * diff --git a/.gitignore b/.gitignore index 57872d0..9fd1dab 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ +.idea /vendor/ diff --git a/README.md b/README.md index d4b84a2..5dde5fd 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# lumen-search -Search module for the Lumen PHP framework. +# Lumen Search + +[![Code Climate](https://codeclimate.com/github/nordsoftware/lumen-search/badges/gpa.svg)](https://codeclimate.com/github/nordsoftware/lumen-search) +[![Latest Stable Version](https://poser.pugx.org/nordsoftware/lumen-search/version)](https://packagist.org/packages/nordsoftware/lumen-search) +[![Total Downloads](https://poser.pugx.org/nordsoftware/lumen-search/downloads)](https://packagist.org/packages/nordsoftware/lumen-search) +[![License](https://poser.pugx.org/nordsoftware/lumen-search/license)](https://packagist.org/packages/nordsoftware/lumen-search) + +Search module for the [Lumen PHP framework](http://lumen.laravel.com/). + +## Requirements + +- PHP 5.3 or newer +- [Composer](http://getcomposer.org) + +## Usage + +### Installation + +Run the following command to install the package through Composer: + +```sh +composer require nordsoftware/lumen-search +``` + +## Contributing + +Please read the [guidelines](.github/CONTRIBUTING.md). + +## License + +See [LICENSE](LICENSE).