README.md in tcollier-commando-0.2.1 vs README.md in tcollier-commando-1.0.0
- old
+ new
@@ -1,32 +1,35 @@
# Commando
-A command line interface builder with Readline support
+Boxers? Briefs? Commando!
+_A command line interface builder with Readline support_
+
## Versions
* `0.1.0` - Initial release
* `0.1.1` - Alphabetize commands printed via `help`
* `0.1.2` - Remove empty lines from history
* `0.2.0` - Persist history across CLI sessions
* `0.2.1` - Fix bug when history file doesn't exist
+* `1.0.0` - Use `ArgumentError` instead of custom error for bad args
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'commando'
+gem 'tcollier-commando'
```
And then execute:
$ bundle
Or install it yourself as:
- $ gem install commando
+ $ gem install tcollier-commando
## Configuration
You can configure the start up greeting, the command line prompt, and the set
of available commands to use.
@@ -55,17 +58,17 @@
* A class/module/instance that fills the `Action` role.
* A brief description of what the command does and what arguments it takes, if any.
#### Action role
-The `Action role` responds to `perform(args, output:)`, where
+The `Action` role responds to `perform(args, output:)`, where
* `args` [`Array<String>`] - the list of the extra words that follow the command
(e.g. if the user types `addfriend mary jane`, then the args are `['mary', 'jane']`).
* `output` [`IO`] - the IO instance that any messages should be written to.
If the arguments are not formatted correctly (e.g. the user missed an argument),
-then method should raise a `Commando::ValidationError` with a descriptive message.
+then method should raise an `ArgumentError` with a descriptive message.
#### Default actions
A few default actions have been registered