README.md in rubikon-0.5.3 vs README.md in rubikon-0.6.0
- old
+ new
@@ -71,17 +71,18 @@
RubyGem's `--version` is an example for an option that requires additional
arguments.
Flags and options are easily added to your application's commands using
Rubikon's DSL:
- flag :more
- option :name, [:who]
- command :hello do
+ flag :more, 'A flag'
+ option :name, 'An option', :who
+ command :hello, 'A command' do
puts "Hello #{who}"
end
-Please see the `samples` directory for more in detail sample applications.
+Please see the [Wiki][5] for more information on the DSL or the `samples`
+directory for more in detail sample applications.
**Warning**:
Rubikon is still in an early development stage. If you want to use it be aware
that you will might run into problems and or restrictions. See the Contribute
@@ -93,17 +94,18 @@
* Automatic checks for option arguments
* Built-in methods to capture user input
* Built-in methods to display progress bars and throbbers
* Built-in support for configuration files
* Built-in support for colored output
-* Automatic generation of a application help screen
+* Automatic generation of application and command help screens
+* User defined validation of option arguments
## Future plans
-* User defined type safety of option arguments
* Improved error handling
-* Automatic generation of command help screens
+* General optimizations
+* Improved tests
## Requirements
* Linux, MacOS X or Windows
* Ruby 1.8.6 or newer (see the [compatibility page][4] in Rubikon's wiki)
@@ -147,9 +149,10 @@
* [GitHub project page][1]
* [GitHub issue tracker][2]
Follow Rubikon on Twitter [@rubikonrb](http://twitter.com/rubikonrb).
- [1]: http://github.com/koraktor/rubikon
- [2]: http://github.com/koraktor/rubikon/issues
+ [1]: https://github.com/koraktor/rubikon
+ [2]: https://github.com/koraktor/rubikon/issues
[3]: http://koraktor.github.com/rubikon
- [4]: http://github.com/koraktor/rubikon/wiki/Compatibility
+ [4]: https://github.com/koraktor/rubikon/wiki/Compatibility
+ [5]: https://github.com/koraktor/rubikon/wiki