Skip to content

Commit

Permalink
Updated the README
Browse files Browse the repository at this point in the history
  • Loading branch information
matejak committed Jul 6, 2016
1 parent 4ac729e commit a9de0f8
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Give a `Argbash` a try and stop being terrorized by those pesky arguments! With
* Fast, minimalistic declaration of arguments your script expects (positional, optional, long, short, boolean).
* Generate script from definitions once and use it afterwards on all platforms that have `Bash`!
* Definitions will stay embedded in few lines of the script itself (so you can use `Argbash` to regenerate the parsing part of your script easily).
* You can re-use low-level `Argbash`-aware scripts by wrapping them by higher-level `Argbash`-aware ones conveniently, without duplicating code.
* Easy installation. Just [grab a release](https://github.com/matejak/argbash/releases), unzip it, go inside and run `cd resources && make install` (you may want to run `sudo make install PREFIX=/usr/bin` for a system-wide installation).
* [Documentation](http://argbash.readthedocs.org/en/latest/) and [examples](resources/examples).

Expand All @@ -29,9 +30,11 @@ See the `resources/examples/simple.m4s` for source and `resources/examples/simpl

Following arguments are supported:

- Positional arguments,
- Positional arguments (defaults supported, possibiliy of fixed, variable or infinite number of arguments),
- optional arguments that take one value,
- boolean optional arguments and
- boolean optional arguments,
- repeated (i.e. non-overwriting) optional arguments,
- incrementing (such as --verbose) optional arguments and
- action optional arguments (such as --version, --help).

The utility has been inspired by Python's `argparse` and the `shflags` project.
Expand Down

0 comments on commit a9de0f8

Please sign in to comment.