docs(readme): add the readme
This commit is contained in:
parent
0ee1015dcb
commit
82cc3737a0
20
README.md
Normal file
20
README.md
Normal file
|
@ -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]
|
||||
```
|
Loading…
Reference in a new issue