diff --git a/README.md b/README.md index 4acdad0..8b21c36 100644 --- a/README.md +++ b/README.md @@ -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.
+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. +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.
+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`.
+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`.
+Please change this path to your desired backup location. + ## Contributing Contributions are always welcome!