Skip to content
This repository has been archived by the owner on Dec 3, 2019. It is now read-only.

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk committed Mar 4, 2016
1 parent 01f3b01 commit 45d37d2
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
(Please read the [guidelines](.github/CONTRIBUTING.md) before creating PRs.)

Fixes #.

Changes proposed in this pull request:
*
*
*
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.idea
/vendor/
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 45d37d2

Please sign in to comment.