diff --git a/assets/vault-hunters-3rd.png b/assets/vault-hunters-3rd.png new file mode 100644 index 0000000..6c7a3fe Binary files /dev/null and b/assets/vault-hunters-3rd.png differ diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..91f5fba --- /dev/null +++ b/readme.md @@ -0,0 +1,35 @@ +Keep Running +--- + +Keep running is a quick and easy way to **keep** a process **running** during development or other **non-production** tasks. + +> Please for the love of sanity, do not use this is production... + +# Usage + +Below you will see the output of the `--help` command. +Do note that if you don't specify any `--per-*` flag, it defaults to `--per-minute=4`. + +``` +Usage: kr [OPTIONS] + +Arguments: + + +Options: + --per-minute [default: 0] + --per-hour [default: 0] + --delay [default: 0] + -h, --help Print help + -V, --version Print version +``` + +# Use cases + +## Game servers + +/keep-running/ is a great tool to run, for example, a Modded minecraft server. +As it automatically restarts the server if a crash occurs. + +![img.png](assets/vault-hunters-3rd.png) +