Skip to content

Commit f58ea9e

Browse files
committed
Added a section to the README about how to use the library
1 parent add1aaa commit f58ea9e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ Takes arguments passed in nearly any format to a bash script and allows easy acc
44

55
## Use
66

7+
### How To Use
8+
9+
Just include the library in the head of script and call the parser function
10+
11+
```bash
12+
# Include the Argument Parser library
13+
source ./my/lib/path/argument-parser.sh
14+
15+
# Parse any arguments
16+
argParse
17+
```
18+
719
### Get An Arguments Value
820

921
There is a helper function named `argValue()` which takes the name of

0 commit comments

Comments
 (0)