README.rdoc in boson-0.1.0 vs README.rdoc in boson-0.2.0

- old
+ new

@@ -1,19 +1,23 @@ == Description A command/task framework similar to rake and thor that opens your ruby universe to the commandline and irb. For my libraries that use this, see {irbfiles}[http://github.com/cldwalker/irbfiles]. Works with Ruby 1.8.6 and 1.9.1. +Note: To read a linkable version of this README, {see here}[http://tagaholic.me/boson/doc/]. + == Features * Commands are just methods extended for a given object, the default being the top level object, main. * Commands are accessible from the commandline (Boson::BinRunner) or irb (Boson::ConsoleRunner). * Command libraries, which are just modules, are written in non-dsl ruby which allows for easy testing and use outside of boson (Boson::FileLibrary). * Comes with default commands to load, search, list and install commands and libraries (Boson::Commands::Core). * Commands can be full-blown commandline apps thanks to powerful options (Boson::OptionParser) and hirb's views. -* Commands can have views toggled without adding view code to your original command (Boson::Scientist). +* There are 5 default option types: boolean, array, string, hash and numeric. Custom option types + can be defined to map to any Ruby class with one method (Boson::Options). +* Commands can have views toggled without adding view code to the original command (Boson::Scientist). * Command libraries are social as a user can install them from a url and then customize command names and options without changing the original library. * Namespaces are optional and when used are methods which allow for method_missing magic. == Irb Example @@ -83,11 +87,11 @@ | web_core | 3 | | module | +----------+----------+------+--------------+ 2 rows in set # Let's install another library - bash> boson install http://github.com/cldwalker/irbfiles/raw/master/boson/commands/irb_core.rb + bash> boson install http://github.com/cldwalker/irbfiles/raw/master/boson/commands/public/irb_core.rb Saved to /Users/bozo/.boson/commands/irb_core.rb # Let's start irb ... bash> irb @@ -130,21 +134,29 @@ == Creating Command Libraries See Boson::FileLibrary or here[http://tagaholic.me/boson/doc/classes/Boson/FileLibrary.html]. == Todo -* More docs * More tests * Making commands out of existing gems easier and more powerful * Better local repositories, perhaps a BosonFile * Consider managing extensions to core and standard libraries * Consider dropping alias gem dependency if not using its full potential +== Bugs/Issues +Please report them {on github}[http://github.com/cldwalker/boson/issues]. + == Motivation My {tagging obsession}[http://github.com/cldwalker/tag-tree] from the ruby console. +== Links +* http://tagaholic.me/2009/10/14/boson-command-your-ruby-universe.html +* http://tagaholic.me/2009/10/15/boson-and-hirb-interactions.html +* http://tagaholic.me/2009/10/19/how-boson-enhances-your-irb-experience.html + == Acknowledgements Boson stands on the shoulders of these people and their ideas: +* Yehuda Katz for inspiring me with Thor's power and elegant design * Yehuda Katz and Daniel Berger for an awesome option parser (Boson::OptionParser) * Dave Thomas for scraping a method's comments (Boson::CommentInspector) * Mauricio Fernandez for scraping a method's arguments (Boson::ArgumentInspector) * Chris Wanstrath for inspiring Boson's libraries with Rip's packages.