README.md in ajax_pagination-0.4.0 vs README.md in ajax_pagination-0.5.0

- old
+ new

@@ -5,22 +5,14 @@ Handles AJAX pagination for you, by hooking up the links you want to load content with javascript in designated page containers. Each webpage can have multiple page containers, each with a different set of pagination links. The page containers can be nested. Degrades gracefully when javascript is disabled. Basically, there is a helper function to use to create a section in your webpage, where content can be changed. Links can reference the section, and thus load new content into it. +This gem currently assumes you are using Rails 3.1+, and the assets pipeline for the javascript and css files. + For more, see [Introduction and Background](https://github.com/ronalchn/ajax_pagination/wiki/Introduction-and-Background). -## Features - -* So easy to use, you don't need to touch a single line of javascript -* Supports multiple and nested sections -* Supports browser history, for more see [Robust Support for Browser History in AJAX Pagination](https://github.com/ronalchn/ajax_pagination/wiki/Robust-Support-for-Browser-History-in-AJAX-Pagination) -* Supports links, but also POST, DELETE, PUT links and forms. Then all can be used to change the content in a section -* Supports redirects - a necessary feature when used with forms -* Custom javascript events -* Built in visual cues when loading new content - can be altered with css. - ## Installation Add to your Gemfile: gem 'ajax_pagination' @@ -36,11 +28,11 @@ //= require ajax_pagination ``` ```css /* app/assets/stylesheets/application.css - * require ajax_pagination + *= require ajax_pagination */ ``` ## Getting Started To learn how to use this gem, read one of the usage guides below (found in the wiki): @@ -49,9 +41,19 @@ * [Adding AJAX to site navigation](https://github.com/ronalchn/ajax_pagination/wiki/Adding-AJAX-to-site-navigation) For more, including how specific features work, look in the [wiki](https://github.com/ronalchn/ajax_pagination/wiki/Home). Alternatively, to see the API, see [RDoc](http://rdoc.info/gems/ajax_pagination/frames). + +## Features + +* So easy to use, you don't need to touch a single line of javascript +* Supports multiple and nested sections +* Supports browser history, for more see [Robust Support for Browser History in AJAX Pagination](https://github.com/ronalchn/ajax_pagination/wiki/Robust-Support-for-Browser-History-in-AJAX-Pagination) +* Supports links, but also POST, DELETE, PUT links and forms, which can all be used to change the content in a section +* Supports redirects - a necessary feature when used with forms +* Custom javascript events +* Built in visual cues when loading new content - can be altered with css. ## Example Application This gem contains an example application (actually, it is there also for testing purposes), however it is nevertheless a good example. Clone this repository, and run the server, using: