Skip to content

Commit

Permalink
Add features section to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrmurach committed Apr 16, 2020
1 parent 57a0d2e commit df61d65
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@

> Parser for command line arguments, keywords, options and environment variables
## Features

* Supports parsing of arguments, keywords, flags, options and environment variables
* Exposes a powerful DSL or hash-like way to specify various settings
* Flexible parsing of arguments that can handle lists and maps separated by comma or space characters
* Has a variety of conversions for basic types like integer and more complex like lists and maps

## Installation

Add this line to your application's Gemfile:
Expand Down Expand Up @@ -234,7 +241,7 @@ argument :foo do
end
```

To match at at least one time use `one_or_more` or `two_or_more` for two times:
To match at at least one time use `one_or_more` or `two_or_more` for many times:

```ruby
option :foo do
Expand Down Expand Up @@ -330,7 +337,7 @@ end

The `permit` setting allows you to restrict an input to a set of possible values:

```
```ruby
option :foo do
long "--foo string"
permit ["bar", "baz"]
Expand Down

0 comments on commit df61d65

Please sign in to comment.