README.md in mobile_pagination-0.0.6 vs README.md in mobile_pagination-0.0.7
- old
+ new
@@ -1,20 +1,19 @@
-mobile_pagination
+MobilePagination
=========
[](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)
-## Requirements
+Gem for producing minimal pagination links, best suited for smaller screens.
-...
+
## Installation
-
Add this line to your application's Gemfile:
gem 'mobile_pagination'
And then execute:
@@ -90,10 +89,12 @@
end
end
end
```
+Please note, any methods ending in `_link` will need to remain, as these methods are responsible for generating the paginated urls.
+
### Configuration
Configuration is optional.
Say for example you were paginating slides on a slideshow - instead of using page, you could configure the gem to use a different key.
@@ -103,14 +104,11 @@
end
```
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.
-...
-
## 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'`)
@@ -120,13 +118,9 @@
## Running the Tests
`rake`
There is a default `spec` task that will run.
-
-## Credits
-
-...
## License
mobile_pagination is released under the MIT License. See the bundled LICENSE file for details.