From 004a6d54e486eefbe5e8c708b1bd49a3105bbb98 Mon Sep 17 00:00:00 2001
From: Dave Lane <dave@oerfoundation.org>
Date: Thu, 9 Jun 2022 03:36:03 +0000
Subject: [PATCH] Add README.md

---
 README.md | 3 +++
 1 file changed, 3 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9255ffb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,3 @@
+The purpose of this script is to backup the contents of Docker container-based database (either PostgreSQL or MariaDB) to a local 'dump' file (SQL format), which is then compressed to conserve disk space. 
+
+The system is designed to be run regularly (perhaps hourly, or daily) via cron, and to keep a pre-determined (via configuration) number of past, deleting excess backup files to conserve disk space.