first commit

README.md

@@ -0,0 +1,23 @@
+# Photowall API 2
+
+Provides a REST API to Photowall database.
+
+## Installation
+
+`$ pip install -r requirements.txt`
+
+## Configuration
+
+First copy config.sample.py to config.py. This file will be read by the application on startup.
+
+List of available configuration options:
+
+| Name | Description |
+| ---- | ----------- |
+| `SQLALCHEMY_DATABASE_URI` | Database connection string.  e.g: `postgresql://user:password@localhost/photowall`
+
+## Getting started
+
+Starting the application:
+
+`$ python run.py`