README.md in parelation-0.0.1 vs README.md in parelation-0.1.0
- old
+ new
@@ -1,29 +1,30 @@
# Parelation
+[](http://badge.fury.io/rb/parelation)
[](https://codeclimate.com/github/meskyanichi/parelation)
[](https://travis-ci.org/meskyanichi/parelation)
Parelation, for Rails/ActiveRecord 4.1.0+, allows you to query your ActiveRecord-mapped database easily, securely and quite flexibly using simple GET requests. It's used in your controller layer where it uses HTTP GET parameters to build on the ActiveRecord::Relation chain. This provides the client-side with the out-of-the-box flexibility to perform fairly dynamic queries without having to write boilerplate on the server.
This library was developed for- and extracted from [HireFire].
+The documentation can be found on [RubyDoc].
+
### Compatibility
- Rails/ActiveRecord 4.1.0+
- Ruby (MRI) 2.0+
-- Ruby (RBX) 2.2+
### Installation
-Compile and install the gem from source.
+Add the gem to your Gemfile and run `bundle`.
```rb
-gem "parelation", github: "meskyanichi/parelation"
+gem "parelation"
```
-*This library won't be hosted on RubyGems.org until it's been tested more in development.*
### Example
Here's an example to get an idea of how it works. We'll fetch the `50` most recently created and `open` tickets, and we only want their `id`, `name` and `message` attributes.
@@ -239,11 +240,10 @@
### Contributing
Contributions are welcome, but please conform to these requirements:
- Ruby (MRI) 2.0+
-- Ruby (RBX) 2.2+
- ActiveRecord 4.1.0+
- 100% Spec Coverage
- Generated by when running the test suite
- 100% [Passing Specs]
- Run test suite with `$ rspec spec`
@@ -265,10 +265,16 @@
```
rspec spec
rubycritic lib
```
+To run the local documentation server:
+
+```
+yard server --reload
+```
+
Create a new branch and start hacking:
```
git checkout -b my-contributions
```
@@ -276,13 +282,13 @@
Submit a pull request.
### Author / License
-Copyright (c) 2014 Michael van Rooijen ( [@meskyanichi] )<br />
-Released under the MIT [License].
+Released under the [MIT License] by [Michael van Rooijen].
-[@meskyanichi]: https://twitter.com/meskyanichi
+[Michael van Rooijen]: https://twitter.com/meskyanichi
[HireFire]: http://hirefire.io
[Passing Specs]: https://travis-ci.org/meskyanichi/parelation
[Code Climate Score]: https://codeclimate.com/github/meskyanichi/parelation
-[License]: https://github.com/meskyanichi/parelation/blob/master/LICENSE
+[RubyDoc]: http://rubydoc.info/github/meskyanichi/parelation/master/frames
+[MIT License]: https://github.com/meskyanichi/parelation/blob/master/LICENSE