README.md in rubikon-0.3.0 vs README.md in rubikon-0.4.0
- old
+ new
@@ -26,34 +26,34 @@
Creating a Rubikon application is as simple as creating a Ruby class:
require 'rubygems'
require 'rubikon'
- class MyApplication < Rubikon::Application
+ class MyApplication < Rubikon::Application::Base
end
If you save this code in a file called `myapp.rb` you can run it using
`ruby myapp.rb`. Or you could even add a *shebang* (`#!/usr/bin/env ruby`) to
the top of the file and make it executable. You would then be able to run it
even more easily by typing `./myapp.rb`.
Now go on and define what your application should do when the user runs it.
This is done using `default`:
- class MyApplication < Rubikon::Application
+ class MyApplication < Rubikon::Application::Base
default do
puts 'Hello World!'
end
end
If you run this application it will just print `Hello World!`.
-You can also add command-line options to your appication using `command`:
+You can also add command-line options to your application using `command`:
- class MyApplication < Rubikon::Application
+ class MyApplication < Rubikon::Application::Base
command :hello do
puts 'Hello World!'
end
@@ -72,23 +72,22 @@
arguments.
Flags and options are easily added to your application's commands using
Rubikon's DSL:
flag :more
- option :name, 2
+ option :name, [:who]
command :hello do
- ...
+ puts "Hello #{who}"
end
-
Please see 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 probably run into problems and or restrictions. See the
-Contribute section if you want to help making Rubikon better.
+that you will might run into problems and or restrictions. See the Contribute
+section if you want to help to make Rubikon better.
## Features
* A simple to use DSL
* Automatic checks for option arguments
@@ -130,12 +129,12 @@
*"console"*.
## License
This code is free software; you can redistribute it and/or modify it under the
-terms of the new BSD License. A copy of this license can be found in the LICENSE
-file.
+terms of the new BSD License. A copy of this license can be found in the
+LICENSE file.
## Credits
* Sebastian Staudt -- koraktor(at)gmail.com
@@ -143,9 +142,11 @@
* [Rubikon's homepage][3]
* [API documentation](http://www.rdoc.info/projects/koraktor/rubikon)
* [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
[3]: http://koraktor.github.com/rubikon
[4]: http://github.com/koraktor/rubikon/wiki/Compatibility