README.rdoc in cldwalker-hirb-0.1.1 vs README.rdoc in cldwalker-hirb-0.1.2
- old
+ new
@@ -1,19 +1,19 @@
== Description
Hirb currently provides a mini view framework for console applications, designed with irb in mind.
Given the output of a console application, it renders a view if there is one configured, based on
the output's class. The framework encourages reusing views by letting you package them in classes
-and associate them with any number of output classes. Hirb comes with table views (see
-Hirb::Helpers::Table) which work out of the box with any output class, especially Rails' model
-classes.
+and associate them with any number of output classes. Hirb comes with tree views (see
+Hirb::Helpers::Tree) and table views (see Hirb::Helpers::Table). By default Hirb displays Rails'
+model classes as tables.
== Install
Install the gem with:
- sudo gem install cldwalker-hirb -s http://gems.github.com
+ sudo gem install cldwalker-hirb --source http://gems.github.com
== Rails Example
Let's load and enable the view framework:
bash> script/console
@@ -212,16 +212,17 @@
and colors to work nicely, please fork. To colorize your Hirb output:
Hirb::View.render_method = lambda {|output| puts Wirble::Colorize.colorize(output) }
== Motivation
Table code from http://gist.github.com/72234 and {my console
-app}[http://github.com/cldwalker/tag-tree].
+app's needs}[http://github.com/cldwalker/tag-tree].
== Links
* http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html
+* http://tagaholic.me/2009/03/18/ruby-class-trees-rails-plugin-trees-with-hirb.html
== Todo
-* Create tree views.
-* Possibly add non-view irb goodies ie command manager.
* Configurable max height, which if exceeded activates a pager.
+* Possibly add non-view irb goodies ie command manager.
+* Consider applying multiple views/filters to output.
* Provides helper methods to all view classes.
* Consider adding a template system as needed.