diff --git a/plugins/getopts/README.markdown b/plugins/getopts/README.markdown new file mode 100644 index 0000000..0767143 --- /dev/null +++ b/plugins/getopts/README.markdown @@ -0,0 +1,115 @@ +# getopts +> friendly [`getopts`](http://en.wikipedia.org/wiki/Getopts) for [fish](https://fishshell.com) :fish: + +## Install + +```fish +git clone https://github.com/bucaran/getopts +mv getopts/getopts.fish custom/functions/path +``` + +## Tests + +Tests are implemented via [Oh-My-Fish](https://github.com/bpinto/oh-my-fish) spec runner _fish-spec_. + +## Premise +Every utility / function needs to handle arguments. What usually happens is that every function does all the grunt work to parse `$argv` itself, and while some patterns do tend to recur, it's different almost every time. Enter fish `getopts`. + +## Synopsis + `getopts