From 494ed2bd970f6e2d4670630d4a322e5f96ab80c6 Mon Sep 17 00:00:00 2001
From: Matt Jadud <matthew.jadud@gsa.gov>
Date: Thu, 22 Feb 2024 11:59:35 -0500
Subject: [PATCH] Minimal docs.

---
 .gitignore |  1 +
 README.md  | 29 +++++++++++++++++++++++++++++
 2 files changed, 30 insertions(+)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..1ec6a33
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+gov.gsa.fac.backups
\ No newline at end of file
diff --git a/README.md b/README.md
index 02c4d43..38a078f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
 # go-backup
 
+## to build
+
+```
+go build
+```
+
+## to run
+
+```
+./gov.gsa.fac.backups
+```
+
+to see the options, and
+
+```
+./gov.gsa.fac.backups clone-db-to-db
+```
+
+to backup a source DB to a destination.
+
+## assumptions
+
+* The `ENV` var is set to `LOCAL` for local testing.
+* You have two Postgres containers running, one at port 5432, and another at 6543. 
+
+You can change the local DB values in `config.yaml` to reflect your config.
+
+In a remote environment, the variable `VCAP_SERVICES` is referenced to extract values.
+