summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--readme.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/readme.md b/readme.md
index 0e4aff8..971c469 100644
--- a/readme.md
+++ b/readme.md
@@ -3,11 +3,13 @@
# Installation
### From Source
-First run `cargo install --release` to compile the binary.
+First run `cargo build --release` to compile the binary.
Then run `install.sh` as root to install crab.
+Run `uninstall.sh` as root to uninstall crab.
+
### Arch Based Systems
-If you are on arch-linux, crab is avaliable on the AUR as `crab`.
+If you are on an arch based distro, crab is avaliable on the [AUR](https://aur.archlinux.org/packages/crab) as `crab`.
# Configuration
Crab supports multiple users with persistence. Each line of the config is the username, then `true` of `false` if the crab authentication persists.
@@ -17,4 +19,4 @@ For Example
root true
tylerm false
```
-The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`. \ No newline at end of file
+The default configuration file is stored in `/usr/share/crab/crab.conf` and must be coppied to `/etc/crab.conf`.