diff --git a/README b/README deleted file mode 100644 index 9667d16..0000000 --- a/README +++ /dev/null @@ -1,31 +0,0 @@ -SYNOPSIS - -This is a set of pacman hooks and script that automatically causes snapper to -perform a pre and post snapshot before and after pacman transactions, similar to -how YaST does with OpenSuse. This provides a simple way to undo changes to a -system after a pacman transaction. - -INSTALLATION - -Install the "snap-pac" package using pacman. - -Alternatively download the latest release and signature from -https://github.com/wesbarnett/snap-pac/releases, verify the download, and then -run "make install". - -I have signed the release tarball and commits with my PGP key. The key's -fingerprint is "8535CEF3F3C38EE69555BF67E4B5E45AA3B8C5C3". - -Starting with release 2.2, the tarballs are signed with my key with fingerprint "F7B2 -8C61 944F E30D ABEE B0B0 1070 BCC9 8C18 BD66". - -DOCUMENTATION - -See snap-pac(8) after installation. - -TROUBLESHOOTING - -After reviewing the man page, check the issues page and file a new issue if your -problem is not covered: - -https://github.com/wesbarnett/snap-pac/issues diff --git a/README.md b/README.md new file mode 100644 index 0000000..7d0f968 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# snap-pac + +## Synopsis + +This is a set of pacman hooks and script that automatically causes snapper to +perform a pre and post snapshot before and after pacman transactions, similar to +how YaST does with OpenSuse. This provides a simple way to undo changes to a +system after a pacman transaction. + +## Installation + +Install the `snap-pac` package using pacman. + +Alternatively [download the latest release] and signature , verify the download, and +then run `make install`. + +I have signed the release tarball and commits with my PGP key. The key's +fingerprint is `8535CEF3F3C38EE69555BF67E4B5E45AA3B8C5C3`. + +Starting with release 2.2, the tarballs are signed with my key with fingerprint `F7B2 +8C61 944F E30D ABEE B0B0 1070 BCC9 8C18 BD66`. + +## Documentation + +Run `man 8 snap-pac` after installation. + +## Troubleshooting + +After reviewing the man page, [check the issues page] and file a new issue if your +problem is not covered. + +[download the latest release]: https://github.com/wesbarnett/snap-pac/releases +[check the issues pages]: https://github.com/wesbarnett/snap-pac/issues