README

1 files changed, 27 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..bd9cfd0
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,27 @@
+┌───────────────────────────┐
+│  ____  ____   ____ ____   │
+│ |  _ \| __ ) / ___|  _ \  │
+│ | | | |  _ \| |   | | | | │
+│ | |_| | |_) | |___| |_| | │
+│ |____/|____/ \____|____/  │
+└───────────────────────────┘
+
+Dumb as Brains Continuous Delivery - NOT FOR PRODUCTION USE.
+
+Features:
+- Configuration of tasks via singular JSON file
+- Automatic polling and logging of task runs
+
+A simple Python script to automatically test/build/deploy code in
+remote Git repositories when a change occurs on them, logging the
+process for consumption by other services.
+
+Of course this is really unsafe.  You should really use a proper CI/CD
+platform for anything important.  Also GitHub workflows exists, and is
+usually free.
+
+So really you only want to use this script if:
+- You don't want to use GitHub workflows
+- You want to be able to automatically test your code without much
+  setup
+... in which case, maybe this script can fit that niche!