diff --git a/README.md b/README.md index 0283c52..e267ad9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,63 @@ # ah -Yet another AUR helper +A declarative package manager for Arch Linux ## What is ah? -AH is a wrapper for paru that allows for declarative management of packages on your system. +Arch Helper is a declarative package management tool for Arch Linux. It leverages paru or other package managers for seamless integration. It is currently in early development phase so watch out for bugs! + +## Installation + +Install Rust :crab: + +```sh +$ sudo pacman -S rustup +``` + +Initialize default stable + +```sh +$ rustup default stable +``` + +Clone this repo +```sh +$ git clone https://github.com/eRgo35/ah +``` +Change directory + +```sh +$ cd ah +``` + +Install package + +```sh +$ makepkg -si +``` + +## Usage + +```txt +$ ah --help +Arch Helper is a declarative package management tool for Arch Linux. It leverages paru or other package managers for seamless integration. + +Usage: ah [COMMAND] + +Commands: + install Install packages + upgrade Upgrade packages + sync Synchronize packages + remove Remove packages + find Find packages + help Print this message or the help of the given subcommand(s) + +Options: + -h, --help + Print help (see a summary with '-h') + + -V, --version + Print version +```