README.md in mobile_pagination-0.0.2 vs README.md in mobile_pagination-0.0.3

- old
+ new

@@ -1,13 +1,12 @@ # MobilePagination ## Description -Rack gem for producing minimal pagination links. +Gem for producing minimal pagination links, best suited for smaller screens. ![<Display Name>](http://i.imgur.com/qZcqfx8.png) - ## Installation Add this line to your application's Gemfile: gem 'mobile_pagination' @@ -22,10 +21,16 @@ ## Usage Initializes with 4 options: `current_page, total_pages, query, path` ```ruby +# in your view, you may have something like this: +ol + = pagination + +# in your helpers, you might have something like: + require 'mobile_pagination' # http://local.m.newhomeguide.com/New-Homes/Georgia/Atlanta/?page=2 def opts @@ -39,26 +44,12 @@ def pagination MobilePagination::Paginate.new(opts).html end -# in your view, you may have something like this: -ol - = pagination ``` -### 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. - -```ruby -MobilePagination.configure do |config| - config.page_key = 'slide' -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`. - ### Overrides If you don't like list items, you will need to override `MobilePagination::Templates` Just add this to the bottom of one of your view helpers: @@ -92,12 +83,26 @@ end end end ``` +### 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. + +```ruby +MobilePagination.configure do |config| + config.page_key = 'slide' +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. +### Testing +`rspec spec` ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)