first upload

README.md

@@ -1,2 +1,49 @@
 # miaur
+
 A lightweight AUR helper written in pure Bash. No helper compilation required.
+
+Its everyday commands follow paru, including `-Syu`, `-S`, `-Ss`, `-Qua`, and `-G`.
+
+## Install
+
+```bash
+git clone https://github.com/WHC2006/miaur.git
+cd miaur
+./install.sh
+```
+
+One command:
+
+```bash
+bash <(curl -fsSL https://raw.githubusercontent.com/WHC2006/miaur/main/install.sh)
+```
+
+Install for the current user under `~/.local`:
+
+```bash
+./install.sh --user
+```
+
+The installer adds the required packages automatically: `base-devel`, `git`, `curl`, and `jq`.
+
+## Usage
+
+```bash
+miaur                 # Upgrade everything (same as -Syu)
+miaur foo             # Search and select packages interactively
+miaur -S <package>    # Install a package
+miaur -Ss <query>     # Search packages
+miaur -Qua            # List available AUR upgrades
+miaur -Sua            # Upgrade AUR packages only
+miaur -G <package>    # Download a PKGBUILD
+```
+
+Run `miaur -h` for more options.
+
+## Configuration
+
+The optional configuration file is `~/.config/miaur/miaur.conf`. See `config/miaur.conf.example`.
+
+## License
+
+MIT