From f872136ba2708a064ab068edc0ee53fb6479428e Mon Sep 17 00:00:00 2001 From: James Barnett Date: Fri, 11 Mar 2016 10:07:40 -0600 Subject: [PATCH] update readme --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3281d0a..8d044bb 100644 --- a/README.md +++ b/README.md @@ -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.