diff --git a/README.md b/README.md index c0b48dd..e0c0562 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,31 @@ # iexec - - Run a command with fixed intervals until you want to stop -run `iexec -h` for usage. \ No newline at end of file +run `$ iexec -h` for usage. + +```shell +Options: + -V, --version output the version number + -c, --command Command to execute wrapped in (default: null) + -a, --arg [arg] Arguments for the command (default: []) + -i, --interval [milliseconds] Interval milliseconds (default: 1000) + -w, --wait Wait until execution ends before running a new process (default: false) + -h, --help output usage information +``` + +example: +`$ iexec -c command -a arg1 -a arg2` +will run this command every second: +`$ command arg1 arg2` + + +## Install +Clone the repo. +run these commands: + +```shell +$ npm install #OR yarn install +$ npm link +``` + +Now you can use the `iexec` command everywhere \ No newline at end of file