Add README.md

2022-05-30 00:19:22 +02:00
parent 4d866f9608
commit 3ef29ba7bc
1 changed files with 10 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,10 @@
+# butterup
+Backup btrfs snapshots over ssh.
+
+## Usage
+Point butterup at a folder containing btrfs subvolumes named according to RFC 3339, it will upload them to a remote host using ssh.
+
+For detailed usage:
+```sh
+butterup help
+```