Create README.md

kamildzi · Feb 19, 2023 · 6a00ffb · 6a00ffb
1 parent 86d7678
commit 6a00ffb
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# EEsync
+EEsync - easy solution for encrypted backups (based on rsync and EncFS)
+
+# Requirements
+- rsync 3.2.7 or higher
+- EncFS 1.9.5 or hidher
+- Python 3.10 or higher
+
+# How to start
+Just run:
+```bash
+./eesync.py
+```
+An interactive menu will appear that will guide you through the process.
+
+# Configuration
+Base configuration can be found in `GeneralSettings.py`.
+Extra configuration gets saved in `SavedConfig` folder.