Port to svelte

[rbdr/lgtm] / README.md

diff --git a/README.md b/README.md
index 3f1f2aaaa6941ccec50eff8d0dedda01ee73ae17..78103afb374aeafdd2bee1633245827fd250ae05 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
 # lgtm
 looks good to me
+
+## What you'll need
+
+You should have node and a mysql database where we can create and read a table.
+
+## Configuring the app
+
+The app is configured using environment variables. You can check
+`config/config.js` to see the expected keys. Most values are optional and
+the defaults should work fine, you will have to provide three values for
+the database connection as no defaults are provided:
+
+* `LGTM_MYSQL_USER`
+* `LGTM_MYSQL_PASSWORD`
+* `LGTM_MYSQL_DATABASE`
+
+An easy way to configure this app for local development is by using a `.env`
+file in the project root. An example one is provided in `env.dist`, you can
+copy that file and update with your own defaults.
+
+## Setting Up the Database
+
+Run `npm run setup_database`. This will create the table.
+
+## Running
+
+Run `npm start`