summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEllie Huxtable <e@elm.sh>2021-02-14 23:33:14 +0000
committerGitHub <noreply@github.com>2021-02-14 23:33:14 +0000
commit80815d9eea86e53b51f9e764d4dcceb590d5a844 (patch)
treefa81f54bf394c6b29fad382edb62209dfcf9d325
parent26bf61ff670e342c261ac78df11e44d51c64bcd9 (diff)
Update README.md
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 86aa6191..9ff1a980 100644
--- a/README.md
+++ b/README.md
@@ -27,17 +27,31 @@ As well as the expected command, A'tuin stores
## Install
+### AUR
+A'tuin is available on the [AUR](https://aur.archlinux.org/packages/atuin/)
+```
+yay -S atuin # or your AUR helper of choice
+```
+
+### With cargo
`atuin` needs a nightly version of Rust + Cargo! It's best to use
[rustup](https://rustup.rs/) for getting set up there.
```
rustup default nightly
+
+cargo install atuin
```
+### From source
```
-cargo install atuin
+rustup default nightly
+git clone https://github.com/ellie/atuin.git
+cd atuin
+cargo install --path .
```
+### Shell plugin
Once the binary is installed, the shell plugin requires installing:
zplug: