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

- old
+ new

@@ -1,26 +1,30 @@ == 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. == Features -* Commands are just methods that are extended by the toplevel object, main. -* Commands are accessible from the commandline or irb. -* Command libraries can be written as plain ruby which allows for easy testing and use outside of boson. -* Commands can be full-blown commandline apps thanks to automatic views from hirb and powerful - options similar to thor's. +* 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). * 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 allows for method_missing magic. +* Namespaces are optional and when used are methods which allow for method_missing magic. == Irb Example -To use in irb, drop this in your irbrc: +To use in irb, drop this in your ~/.irbrc: require 'boson' - Boson.start :verbose=>true + Boson.start -Let's start up irb: +Having done that, let's start up irb: bash> irb Loaded library core Loaded library web_core @@ -122,12 +126,25 @@ +-------------------------------+----------+------------+--------------------------------------------+-----------------------------------------------------------------------------+ 28 rows in set # Sweet! Now we have a list and description of commands that come with irb. -== Creating commands -TODO: Explain library format +== Creating Command Libraries +See Boson::FileLibrary or here[http://tagaholic.me/boson/doc/classes/Boson/FileLibrary.html]. == Todo * More docs * More tests -* Add tags to libraries + commands +* 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 + +== Motivation +My {tagging obsession}[http://github.com/cldwalker/tag-tree] from the ruby console. + +== Acknowledgements +Boson stands on the shoulders of these people and their ideas: +* 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.