aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Powers <markppowers0@gmail.com>2019-01-27 13:59:00 -0500
committerMark Powers <markppowers0@gmail.com>2019-01-27 13:59:00 -0500
commitd92cd24dc7d7a6b7fcaf2f208a955ceb59e989c3 (patch)
tree143a8f84a2f70fc52ee8fc4c8728c74d64ac4478
parenta16648b1af583e16e43b421bcd980ddcef304b51 (diff)
Update readme
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8d50786..b325d16 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,12 @@
Configuration:
-- Requires markskitchen user to have access to markskitchen mysql databse
-- Set password on env var 'MARKSKITCHENPWD' \ No newline at end of file
+- 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"
+ }
+}
+```