summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLee Jarvis <ljjarvis@gmail.com>2013-08-29 15:30:47 +0100
committerLee Jarvis <ljjarvis@gmail.com>2013-08-29 15:30:47 +0100
commite9829e9da502ef5edf531dfa33c2677082e2d068 (patch)
treec14e9441138a52e9cea59c10c9d0db3125339b73 /README.md
parent04174ed89697a15af6d0942252b1232d7e816e3d (diff)
downloadslop-e9829e9da502ef5edf531dfa33c2677082e2d068.tar.gz
Added advanced usage to readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index e2abf4a..c737c90 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,35 @@ opts[:name] #=> 'lee'
opts.to_hash #=> {:name=>"Lee", :password=>nil, :verbose=>true}
```
+Advanced Usage
+--------------
+
+```ruby
+Slop.parse do
+ on :v, :verbose, 'Enable verbose mode'
+
+ cmd :add, ignore_case: true do
+ on :f, :force, 'Force add'
+ on :d, :dir=, 'Output directory'
+
+ process do |cmd, opts|
+ puts "Adding #{opts.first} to #{cmd[:dir]} ..."
+ end
+ end
+
+ cmd :rm do
+ on :f, :force, 'Force rm'
+
+ process do |cmd, opts|
+ unless cmd.force?
+ abort "--force must be present"
+ end
+ end
+ end
+
+end
+```
+
Installation
------------