diff options
| -rw-r--r-- | readme.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..b659123 --- /dev/null +++ b/readme.md @@ -0,0 +1,15 @@ +# **Crab** +`Crab`, a.k.a `Cool Rust Authentication Binary` is a rusty replacement for sudo and doas on Linux systems + +# Installation +Run `build.sh` as the root user to build the rust binary, and install files. + +# Configuration +Crab supports multiple users and persistence. Each line of the config is the username, then `true` of `false` if the crab authentication persists, seperated by a space. + +For Example +``` +root true +tylerm false +``` +The configuration file is stored in `/etc/crab.conf`
\ No newline at end of file |