Skip to content

Commit 4e8c698

Browse files
committed
Added the argument array to the how to use section of the README
1 parent f58ea9e commit 4e8c698

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@ Takes arguments passed in nearly any format to a bash script and allows easy acc
66

77
### How To Use
88

9-
Just include the library in the head of script and call the parser function
9+
Just include the library in the head of script, define all the arguments you need and call the parser function
1010

1111
```bash
1212
# Include the Argument Parser library
1313
source ./my/lib/path/argument-parser.sh
1414

15+
# Define the expected arguments
16+
argExpected['test']="argName - This is a short description of the argument and what it does"
17+
argExpected['R']="secondArgName - This is another argument that can be passed"
18+
1519
# Parse any arguments
1620
argParse
1721
```

0 commit comments

Comments
 (0)