aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3d025ff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+Email newsletter management for my website.
+
+Configuration:
+- Requires mysql database. Include a `config.json` in `src` directory with the following structure:
+```json
+{
+ "database": {
+ "host": "localhost",
+ "user": "YOUR_USER",
+ "database": "YOUR_DB",
+ "password": "YOUR_PWD"
+ }
+}
+```