readme

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`