README.rdoc in nether-0.0.1 vs README.rdoc in nether-0.0.2
- old
+ new
@@ -8,11 +8,11 @@
Currently only supports apps using the assets pipeline and will_paginate.
== Installation
Add the following to your Gemfile and run the bundle command.
- gem 'nether', :git => "git://github.com/maecro/nether.git"
+ gem 'nether'
Once the gem is installed execute the generator to install the js files and images.
rails generate nether:install
@@ -25,14 +25,17 @@
To use the helper add the following to your view after the will paginate helper, replacing
variables as necessary.
<%= nether(@articles.total_pages, articles_path, "#content" %>
-You must also add the following to the action handling the pagination.
+You must also add a helper to the action handling the pagination. The helper takes the partial to render
+as an argument and an optional argument to delay rendering.
render_nether("articles/article")
+
+== Help
+You will find an example app at nether_example[https://github.com/maecro/nether_example].
== Todo
* Remove dependancy on assets pipeline.
* Compatability with other pagination solutions.
-* Add gem to rubygems.
* Test, test, test.
\ No newline at end of file