README.md in datatable-0.2pre2 vs README.md in datatable-0.2pre3

- old
+ new

@@ -1,54 +1,56 @@ +WARNING!!! +========== + +This gem is not ready for prime-time but if you're feeling adventurous read on.... + +It's likely the code base will experience significant churn in the next few releases as we search for the best way deliver the desired +functionality. If you think this may be a problem you should most likely avoid using this gem for now. On the other hand if you're not +afraid of diving into the code to help us improve it we will certiainly do what we can to make sure it works for you in return. + Datatable ========= This is a [Rails 3.0](http://rubyonrails.org) plugin that provides server-side processing for the [Datatables](http://datatables.net) javascript library. The screenshot below -contains an example with global search, per column search, infinite scrolling and the optional table tools plugin installed using the jquery ui them 'smoothness'. +contains an example with global search, per column search, infinite scrolling and the optional table tools plugin installed using the jquery ui theme 'smoothness'. ![Alt text](https://github.com/logic-refinery/datatable/raw/master/images/datatable_screenshot.png "optional title") -WARNING!!! -========== -This gem is not ready for primetime but if you're feeling adventurous read on.... - - Introduction ============ -It's likely the code base will experience significant churn in the next few releases as we search for the best way deliver the desired -functionality. If you think this may be a problem you should most likely avoid using it for now. On the other hand if you're not afraid -of diving into the code to help us improve it we will certiainly do what we can to make sure it works -for you in return. +This library is not intended to create a zero configuration admin style interface to your data. It's intended to provide a fairly complete +and flexible interface into your data for the datatables javascript library. It will require a moderate amount of configuration to define +exactly what you want to see, how it should be displayed and the relationship between that view and the database schema. Hopefully though +we can make it so all of that configuration happens in one place with a minimal amount of redundancy. Setup ====== -Because of the fast moving nature of this project for the time being I recomend using bundler and pulling from git. If you -intend to deploy an application using this gem I'd recomend locking your dependency to a specific well tested commit. - Add the following to you Gemfile ```ruby - gem "datatable", :git => "git://github.com/logic-refinery/datatable.git" :ref => "500a5f" + gem "datatable", "~>0.2pre2" ``` Then run bundle install ```sh - bundle + bundle install datatable ``` Then run the generator to create the javascript files and code templates ```sh rails generate datatable:install ``` -The generator will have added some javascript files to your public/javascript folder that need to be added after jquery using a helper. +The generator will have added some files in public/datatable. At a minimum you need to include the datatables +javascript after jquery. A typical rails applicaiton layout would look something like this. ```erb <%= javascript_include_tag :defaults %> <%= datatable_javascript %> ``` @@ -126,9 +128,13 @@ option('bScrollCollapse', true) option('sScrollY', '200px') end ``` +Documentation +============= + +[wiki](https://github.com/logic-refinery/datatable/wiki) Limitations ========== * It only supports MySQL and PostgreSLQ through ActiveRecord.