aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorpml68 <contact@pml68.dev>2025-09-03 18:50:21 +0200
committerpml68 <contact@pml68.dev>2025-09-03 20:00:18 +0200
commitdaca3448c0a0b06b3977989b095cbab87a54ed68 (patch)
tree0a896423b92da5796b1e47e3b5de617181bc85bd /README.md
parentfeat: add man page (diff)
downloadaur-1.0.0.tar.gz
feat: add Makefilev1.0.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 4 insertions, 12 deletions
diff --git a/README.md b/README.md
index 5b7d650..15276e9 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,10 @@
# aur
-My AUR helper. See `aur -h`
+A small AUR helper script.
-## Shell completion
-
-Bash
+## Installation
```sh
-cp aur-completion.bash ~/.aur-completion.bash
-
-# add this line to your .bashrc
-source ~/.aur-completion.bash
+make install # may require sudo / root privileges
```
-Fish
-```sh
-cp aur.fish ~/.config/fish/completions/
-```
+This will install the `aur` binary, the `man` page and shell completions for fish and bash.