update readme

This commit is contained in:
James Barnett 2016-03-11 10:07:40 -06:00
parent 916cfa86ba
commit f872136ba2

View file

@ -1,10 +1,21 @@
# snap-pac
These are used for Arch Linux's pacman, so that snapper automatically takes a
pre and post snapshot before and after pacman transactions. There's no need to
create aliases, etc. See `man alpm-hooks` and `man snapper` for more
information.
These are used for Arch Linux's pacman, so that [snapper](http://snapper.io)
automatically takes a pre and post snapshot before and after pacman
transactions, similar to how YaST does with OpenSuse.
*Note:* The scripts only take snapshots of the subvolume mounted at "/"; other
subvolumes are not included. You must modify the scripts to include other
subvolumes.
The scripts are set up to use the `number` algorithm. That is, snapper will
cleanup snapshots tagged with `number` after reaching a set threshold in the
configuration file.
See `man alpm-hooks` and `man snapper` for more information.
## Installation
Install [the package from the AUR](https://aur.archlinux.org/packages/snap-pac/).
That's it! Continue to use pacman as normal and watch snapper do its thing.