diff --git a/README.md b/README.md new file mode 100644 index 0000000..7f9dab2 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +Timeout +======= + +`Timeout` executes a command until the timeout is over. +When the command is finished before the timeout then the exit code is `0` else it's `1`. + +Usage +----- + +``` +./timeout [-v] [-h] [-t TIMEOUT] [-c COMMAND] +``` + +Run `./timeout -h` to get the full help. + +### In docker + +``` +docker run -it --rm deblan/timeout [-v] [-h] [-t TIMEOUT] [-c COMMAND] +```