README.rdoc in guilded-1.0.9 vs README.rdoc in guilded-1.0.10
- old
+ new
@@ -80,10 +80,18 @@
* Extends ActiveRecord to have a attr_human_hint method. This method works similar to the attr_human_name method except a hint
to use on forms, etc is being set.
* Extends InactiveRecord (http://github.com/midas/inactive_record/tree/master) to include the attr_human_hint method.
+== COMPATABILITY:
+
+* Ruby 1.9
+* Ruby 1.8
+* Rails 3
+* Rails 2
+
+
== GUILDED COMPONENT PROJECTS
* http://github.com/midas/g_already_grid/tree/master
* http://github.com/midas/g_auto_completer/tree/master
* http://github.com/midas/g_flash_growler/tree/master
@@ -93,14 +101,10 @@
* http://github.com/midas/g_nested_select/tree/master
* http://github.com/midas/g_sectioned_shower/tree/master
* http://github.com/midas/g_toggle_block/tree/master
-== PROBLEMS
-
-
-
== REQUIREMENTS
* jQuery 1.3.2 (included in Guilded)
@@ -115,24 +119,30 @@
sudo gem install guilded
== INSTALL FOR RAILS
-Add to Gemfile file:
+Configure the Gem for use:
- gem 'guilded', '1.0.7'
+ gem 'guilded', '1.0.7' # Rails 3
+ config.gem 'guilded', :version => '1.0.7' # Rails 2
-Run:
+Install the Gem:
- bundle install
+ bundle install # Rails 3
+ rake gems:install # Rails 2
+ gem install guilded # Manual
Generate:
- script/generate guilded_config
- script/generate guilded_assets
+ rails generate guilded_config # Rails 3
+ rails generate guilded_assets # Rails 3
+ script/generate guilded_config # Rails 2
+ script/generate guilded_assets # Rails 2
+
Edit the settings file at config/initializers/load_guilded_settings.rb. Change any of these settings to reflect how
you would like Guilded to be configured. If you change where any file(s) are configured to be located, then also move
the respective file(s).
@@ -141,17 +151,25 @@
=== COMPONENT FRAMEWORK
You must make a call to the view helper to apply the CSS. The raw method must be used with Rails 3 as the new default
escapes strings. It should be placed in your layout:
- <%= raw g_apply_style %>
+ <%= raw g_apply_style %> # Rails 3
+ <%= g_apply_style %> # Rails 2
There is also two view helpers to apply the JavaScript. You can place this at the bottom of your layout(s) (so you
do not have to include it in every template):
+ # Rails 3
<%= raw g_apply_includes %>
<script type="text/javascript">
<%= raw g_apply_behavior %>
+ </script>
+
+ # Rails 2
+ <%= g_apply_includes %>
+ <script type="text/javascript">
+ <%= g_apply_behavior %>
</script>
A before filter is automatically set up in your application controller to reset the Guilded singleton that manages
everything after each rendering. The code looks like this:
\ No newline at end of file