add config to readme

smnorris · Jan 19, 2018 · 80e3d22 · 80e3d22
1 parent d9846b8
commit 80e3d22
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,18 @@ Much is copied directly from [dataset](https://dataset.readthedocs.org/) and fur
 pip install pgdata
 ```
 
+## Configuration
+
+Create an environment variable `DATABASE_URL` and set it to the [SQLAlchemy db url](http://docs.sqlalchemy.org/en/latest/core/engines.html) for your database:
+
+MacOS/Linux etc: 
+
+`export DATABASE_URL=postgresql://postgres:postgres@localhost:5432/mydb`
+
+Windows: 
+
+`SET DATABASE_URL="postgresql://postgres:postgres@localhost:5432/mydb"`
+
 
 ## Usage