README.md in mobile_pagination-0.0.3 vs README.md in mobile_pagination-0.0.4
- old
+ new
@@ -1,14 +1,20 @@
-# MobilePagination
+mobile_pagination
+=========
+[](https://codeclimate.com/github/primedia/mobile_pagination)
+[](https://travis-ci.org/primedia/mobile_pagination)
+[](https://coveralls.io/r/primedia/mobile_pagination?branch=dev)
+[](https://gemnasium.com/primedia/mobile_pagination)
+[](http://badge.fury.io/rb/mobile_pagination)
-## Description
-Gem for producing minimal pagination links, best suited for smaller screens.
+## Requirements
-
+...
## Installation
+
Add this line to your application's Gemfile:
gem 'mobile_pagination'
And then execute:
@@ -17,10 +23,11 @@
Or install it yourself as:
$ gem install mobile_pagination
+
## Usage
Initializes with 4 options: `current_page, total_pages, query, path`
```ruby
# in your view, you may have something like this:
@@ -98,15 +105,27 @@
Configuration must run prior to initialization. The resulting pagination links will now contain `/?slide=2, /?slide=3` to suit your custom url structure. The default page_key is `page`.
Please note, any methods ending in `_link` will need to remain, as these methods are responsible for generating the paginated urls.
-### Testing
-`rspec spec`
+...
## 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
+
+## Running the Tests
+
+`rspec spec`
+
+## Credits
+
+...
+
+## License
+
+mobile_pagination is released under the MIT License. See the bundled LICENSE file for
+details.