summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLee Jarvis <ljjarvis@gmail.com>2013-08-29 15:51:03 +0100
committerLee Jarvis <ljjarvis@gmail.com>2013-08-29 15:51:03 +0100
commit216444073b3fb796de016bb8624c594316e1e587 (patch)
treee9b06267dababc3d67988957da5887af3e5bb143 /README.md
parente9829e9da502ef5edf531dfa33c2677082e2d068 (diff)
downloadslop-216444073b3fb796de016bb8624c594316e1e587.tar.gz
Use a table to show config options
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 6 insertions, 16 deletions
diff --git a/README.md b/README.md
index c737c90..949edcb 100644
--- a/README.md
+++ b/README.md
@@ -68,22 +68,12 @@ can see this by calling `opts.help` or simply `puts opts`.
Configuration Options
---------------------
-All of these options can be sent to `Slop.new` or `Slop.parse` in Hash form.
-
-* `strict` - Enable strict mode. When processing unknown options, Slop will
- raise an `InvalidOptionError`. **default:** *false*.
-* `help` - Automatically add the `--help` option. **default:** *false*.
-* `banner` - Set the help banner text. **default:** *nil*.
-* `ignore_case` - When enabled, `-A` will look for the `-a` option if `-A`
- does not exist. **default:** *false*.
-* `autocreate` - Autocreate options on the fly. **default:** *false*.
-* `arguments` - Force all options to expect arguments. **default:** *false*.
-* `optional_arguments` - Force all options to accept optional arguments.
- **default:** *false*.
-* `multiple_switches` - When disabled, Slop will parse `-abc` as the option `a`
- with the argument `bc` rather than 3 separate options. **default:** *true*.
-* `longest_flag` - The longest string flag, used to aid configuring help
- text. **default:** *0*.
+Key | Description | Default
+--------------------|----------------------------------------------------------------------
+`strict` | Raise `InvalidOptionError` for unknown options | true
+`help` | Automatically add the `--help` option | true
+`ignore_case` | `-A` will be processed the same as `-a` | false
+`multiple_switches` | When disabled, parses `-abc` as `-a` with the argument `bc` | true
Lists
-----