From 1bc7e6d5969ff2481f93de41482b66ef98bf4c15 Mon Sep 17 00:00:00 2001
From: Jarno Rankinen <50285623+0ranki@users.noreply.github.com>
Date: Sun, 2 Aug 2020 22:01:49 +0300
Subject: [PATCH] Update README.md

Added planned features and license
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 6c89ef2..e8387f7 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,16 @@ Btrfs snapshot managing bash script
 - Taking snapshots requires root priviledges. Take a snapshot with `snapsh -s SUBVOLUME` or `snapsh --snapshot SUBVOLUME`, where `SUBVOLUME` is the name of the source subvolume. You can add a description for the snapshot with the `-d | --description` option (must be used before the `-s` option)<br><br>Example with Fedora default btrfs layout with `root` and `home` subvolumes: <br> `snapsh -d "This is a snapshot" -s root` <br> This will create a snapshot called `root_snapshot_YYYY.MM.DD-hh:mm:ss` to the `snapshots` subvolume (or the one you defined with `SNAPSHOTS_LOCATION`), with a description "This is a snapshot"
 - Snapshots can be listed with `snapsh -l` or `snapsh --list`
 - Delete snapshots with the `-r` or `--remove` option. List snapshots first with `snapsh -l`, then delete snapshot with e.g. `snapsh -r 2`, where 2 is the number of the deletable snapshot in the `-l` listing. The list numbers always start from 1 and increment from there, so always check the number before deletion. Batch deletion might be implemented later.
+
+### Planned features:
+- separate config file
+- `--install` option to integrate script into system
+- Batch deletion of snapshots
+- `systemd` timer for automating snapshots
+- `--auto` option (quiet) for automated snapshots
+- Option to snapshot multiple/all subvolumes
+
+Root access is required for `btrfs-progs`.
+
+### License:
+GPL v3.0