README.md in inquisitio-0.0.12 vs README.md in inquisitio-0.0.13
- old
+ new
@@ -1,43 +1,49 @@
# Inquisitio
-TODO: Write a gem description
+[](https://travis-ci.org/meducation/inquisitio)
+[](https://gemnasium.com/meducation/inquisitio)
+[](https://codeclimate.com/github/meducation/inquisitio)
+Inquisitio is a ruby wrapper around Amazon Cloud Search. It is currently under active development.
+
## Installation
Add this line to your application's Gemfile:
gem 'inquisitio'
And then execute:
$ bundle
-Or install it yourself as:
-
- $ gem install inquisitio
-
## Usage
-TODO: Write usage instructions here
+This gem allows you to build and execute queries to run against Amazon Cloud Search.
+```
+results = Inquisitio.where("foobar").per(10).page(2).with(facet: 'thingy')
+results.each do |result|
+ # ...
+end
+```
+
## Contributing
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Firstly, thank you!! :heart::sparkling_heart::heart:
+We'd love to have you involved. Please read our [contributing guide](https://github.com/meducation/inquisitio/tree/master/CONTRIBUTING.md) for information on how to get stuck in.
- ### Contributors
+### Contributors
This project is managed by the [Meducation team](http://company.meducation.net/about#team).
These individuals have come up with the ideas and written the code that made this possible:
- [Jeremy Walker](http://github.com/iHID)
+- [Malcolm Landon](http://github.com/malcyL)
+- [Charles Care](http://github.com/ccare)
## Licence
Copyright (C) 2013 New Media Education Ltd
@@ -49,7 +55,7 @@
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
-A copy of the GNU Affero General Public License is available in [Licence.md](https://github.com/meducation/propono/blob/master/LICENCE.md)
+A copy of the GNU Affero General Public License is available in [Licence.md](https://github.com/meducation/inquisitio/blob/master/LICENCE.md)
along with this program. If not, see <http://www.gnu.org/licenses/>.