From 80e3d2202dc2101c15f23f53d9fe5dabf9f14fe4 Mon Sep 17 00:00:00 2001 From: Simon Norris Date: Fri, 19 Jan 2018 09:53:30 -0800 Subject: [PATCH] add config to readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index eb00a13..a97dd99 100644 --- 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