From b0d13ea2ae42720536b600ec08c1f1918e767361 Mon Sep 17 00:00:00 2001
From: Lee Jarvis <ljjarvis@gmail.com>
Date: Sun, 6 Jan 2013 13:15:42 +0000
Subject: avoid syntax highlighting for readability and simplify usage

---
 README.md | 157 +++++++++++++++++++++++++-------------------------------------
 1 file changed, 64 insertions(+), 93 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 6292187..a12ae7c 100644
--- a/README.md
+++ b/README.md
@@ -5,48 +5,31 @@ Slop is a simple option parser with an easy to remember syntax and friendly API.
 
 [![Build Status](https://secure.travis-ci.org/injekt/slop.png)](http://travis-ci.org/injekt/slop)
 
+Usage
+-----
+
+    opts = Slop.parse do
+      banner "Usage: foo.rb [options]"
+
+      on 'name=', 'Your name'
+      on 'p', 'password', 'An optional password', argument: :optional
+      on 'v', 'verbose', 'Enable verbose mode'
+    end
+
+    # if ARGV is `--name Lee -v`
+    opts.verbose?  #=> true
+    opts.password? #=> false
+    opts[:name]    #=> 'lee'
+    opts.to_hash   #=> {:name=>"Lee", :password=>nil, :verbose=>true}
+
 Installation
 ------------
 
     gem install slop
 
-Usage
------
-
-```ruby
-# parse assumes ARGV, otherwise you can pass it your own Array
-opts = Slop.parse do
-  banner "ruby foo.rb [options]\n"
-  on :name=, 'Your name'
-  on :p, :password, 'Your password', :argument => :optional
-  on :v, :verbose, 'Enable verbose mode'
-end
-
-# if ARGV is `--name Lee -v`
-opts.verbose?  #=> true
-opts.password? #=> false
-opts[:name]    #=> 'lee'
-```
-
-Slop supports several methods of writing options:
-
-```ruby
-# These options all do the same thing
-on '-n', '--name', 'Your name', :argument => true
-on 'n', :name=, 'Your name'
-on :n, '--name=', 'Your name'
-
-# As do these
-on 'p', '--password', 'Your password', :argument => :optional
-on :p, :password, 'Your password', :optional_argument => true
-on '-p', 'password=?', 'Your password'
-```
-
 You can also return your options as a Hash:
 
-```ruby
-opts.to_hash #=> { :name => 'lee', :verbose => true, :password => nil }
-```
+    opts.to_hash #=> { :name => 'lee', :verbose => true, :password => nil }
 
 Printing Help
 -------------
@@ -77,42 +60,36 @@ All of these options can be sent to `Slop.new` or `Slop.parse` in Hash form.
 Lists
 -----
 
-```ruby
-opts = Slop.parse do
-  on :l=, 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"]
-```
+    opts = Slop.parse do
+      on :l=, 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"]
 
 You can also specify a delimiter and limit.
 
-```ruby
-opts = Slop.parse do
-  on :l=, as: Array, delimiter: ':', limit: 2
-end
-# ruby run.rb -l one:two:three
-opts[:l] #=> ["one", "two:three"]
-```
+    opts = Slop.parse do
+      on :l=, as: Array, delimiter: ':', limit: 2
+    end
+    # ruby run.rb -l one:two:three
+    opts[:l] #=> ["one", "two:three"]
 
 Ranges
 ------
 
-```ruby
-opts = Slop.parse do
-  on :r=, 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
-```
+    opts = Slop.parse do
+      on :r=, 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
 
 Autocreate
 ----------
@@ -121,12 +98,10 @@ Slop has an 'autocreate' feature. This feature is intended to create
 options on the fly, without having to specify them yourself. In some case,
 uses this code could be all you need in your application:
 
-```ruby
-# ruby run.rb --foo bar --baz --name lee
-opts = Slop.parse(autocreate: true)
-opts.to_hash #=> {:foo=>"bar", :baz=>true, :name=>"lee"}
-opts.fetch_option(:name).expects_argument? #=> true
-```
+    # ruby run.rb --foo bar --baz --name lee
+    opts = Slop.parse(autocreate: true)
+    opts.to_hash #=> {:foo=>"bar", :baz=>true, :name=>"lee"}
+    opts.fetch_option(:name).expects_argument? #=> true
 
 Woah woah, why you hating on OptionParser?
 ------------------------------------------
@@ -135,37 +110,33 @@ I'm not, honestly! I love OptionParser. I really do, it's a fantastic library.
 So why did I build Slop? Well, I find myself using OptionParser to simply
 gather a bunch of key/value options, usually you would do something like this:
 
-```ruby
-require 'optparse'
+    require 'optparse'
 
-things = {}
+    things = {}
 
-opt = OptionParser.new do |opt|
-  opt.on('-n', '--name NAME', 'Your name') do |name|
-    things[:name] = name
-  end
+    opt = OptionParser.new do |opt|
+      opt.on('-n', '--name NAME', 'Your name') do |name|
+        things[:name] = name
+      end
 
-  opt.on('-a', '--age AGE', 'Your age') do |age|
-    things[:age] = age.to_i
-  end
+      opt.on('-a', '--age AGE', 'Your age') do |age|
+        things[:age] = age.to_i
+      end
 
-  # you get the point
-end
+      # you get the point
+    end
 
-opt.parse
-things #=> { :name => 'lee', :age => 105 }
-```
+    opt.parse
+    things #=> { :name => 'lee', :age => 105 }
 
 Which is all great and stuff, but it can lead to some repetition. The same
 thing in Slop:
 
-```ruby
-require 'slop'
+    require 'slop'
 
-opts = Slop.parse do
-  on :n, :name=, 'Your name'
-  on :a, :age=, 'Your age', :as => :int
-end
+    opts = Slop.parse do
+      on :n, :name=, 'Your name'
+      on :a, :age=, 'Your age', :as => :int
+    end
 
-opts.to_hash #=> { :name => 'lee', :age => 105 }
-```
+    opts.to_hash #=> { :name => 'lee', :age => 105 }
-- 
cgit v1.2.1