update README.md

This commit is contained in:
AustrianToast 2024-09-08 23:02:34 +02:00
parent e2d4253050
commit 67c7f48cd7
Signed by: AustrianToast
GPG Key ID: 1B4D0AAF6E558816

View File

@ -1,18 +1,34 @@
# Update
Alpm hooks for the pacman package manager. This project consists of two hooks, one for pre-transaction and the other for post-transaction.
Alpm hooks for the pacman package manager.<br>
This project consists of two hooks, one for pre-transaction and the other for
post-transaction.
## Installation
```bash
git clone https://gitea.hopeless-cloud.xyz/AustrianToast/update.git && cd update
git clone https://gitea.hopeless-cloud.xyz/AustrianToast/update.git
cd update
```
Before installing, please edit the config and configure it to your liking.
Then install using
```bash
make install
```
If your require the previous functionality of being able to update flatpak and
having the ability to preview the updateable packages and flatpak.<br>
This functionality has been re-packaged into `update.zsh`.
If you use oh-my-zsh, then you just throw this file into your `$ZSH_CUSTOM`.<br>
This path is by default `~/.oh-my-zsh`. If you use only plain zsh or any other
shell, then you can just take the contained functions and put them inside the
according shell config file. For example your `.bashrc`.
The function `flatpak-update` contains a variable called `BACKUP_LOCATION`.<br>
Please change this path to your desired backup location.
## Contributing
Contributions are always welcome!