summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLee Jarvis <ljjarvis@gmail.com>2013-01-06 13:22:29 +0000
committerLee Jarvis <ljjarvis@gmail.com>2013-01-06 13:22:29 +0000
commit8a8760099fdf7808c62549d1aafe59c5a09dd35d (patch)
tree2fb1ee0e1d21e33f7c2293f098345811ad943be6 /README.md
parent04d5d7674dbc3316284bf12640a4ee33bfc3413d (diff)
downloadslop-8a8760099fdf7808c62549d1aafe59c5a09dd35d.tar.gz
use long options in examples rather than short flags
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 17 insertions, 17 deletions
diff --git a/README.md b/README.md
index e7d176c..3f3972f 100644
--- a/README.md
+++ b/README.md
@@ -61,22 +61,22 @@ Lists
```ruby
opts = Slop.parse do
- on :l=, as: Array
+ on :list=, as: Array
end
-# ruby run.rb -l one,two
-opts[:l] #=> ["one", "two"]
-# ruby run.rb -l one,two -l three
-opts[:l] #=> ["one", "two", "three"]
+# ruby run.rb --list one,two
+opts[:list] #=> ["one", "two"]
+# ruby run.rb --list one,two --list three
+opts[:list] #=> ["one", "two", "three"]
```
You can also specify a delimiter and limit.
```ruby
opts = Slop.parse do
- on :l=, as: Array, delimiter: ':', limit: 2
+ on :list=, as: Array, delimiter: ':', limit: 2
end
-# ruby run.rb -l one:two:three
-opts[:l] #=> ["one", "two:three"]
+# ruby run.rb --list one:two:three
+opts[:list] #=> ["one", "two:three"]
```
Ranges
@@ -84,16 +84,16 @@ Ranges
```ruby
opts = Slop.parse do
- on :r=, as: Range
+ on :range=, as: Range
end
-# ruby run.rb -r 1..10
-opts[:r] #=> 1..10
-# ruby run.rb -r 1...10
-opts[:r] #=> 1...10
-# ruby run.rb -r 1-10
-opts[:r] #=> 1..10
-# ruby run.rb -r 1,10
-opts[:r] #=> 1..10
+# ruby run.rb --range 1..10
+opts[:range] #=> 1..10
+# ruby run.rb --range 1...10
+opts[:range] #=> 1...10
+# ruby run.rb --range 1-10
+opts[:range] #=> 1..10
+# ruby run.rb --range 1,10
+opts[:range] #=> 1..10
```
Autocreate