From 76f04b44ac9d8008ac62572ceba8cb7d9179d849 Mon Sep 17 00:00:00 2001
From: Tristan Ancelet <tristan.ancelet@acumera.com>
Date: Sat, 18 May 2024 13:57:10 -0500
Subject: [PATCH] Added documentation on the Features that are planned for the
 util

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 5d7ebbd..c6f67ad 100644
--- a/README.md
+++ b/README.md
@@ -10,3 +10,19 @@ This project is meant to handle & query the filebucket locally on the device of
 
 
 ## Planned Features
+### Search
+This will search for a file by a substring (or full path) of the file you are attempting to view or restore.
+
+### List
+This will simply list out every file that has been backed up to the bucket in `<TIME> : <MD5> : <FILEPATH>` format.
+
+### List-Files 
+This will allow you to just list the specific (unique) files/paths that were backed up to the bucket during puppet runs before they get changed on disk.
+
+You can use this to find the file you are looking for before you search for it using the search action.
+
+### Restore (not implemented yet)
+This will allow you to restore a file on disk to the specific version that is stored in the bucket.
+
+### Get
+The utility will allow you to get the contents of a backup up file and have it output to the terminal.