From 9d16ac4a196d12b016bbc08483aa883af841a8ad Mon Sep 17 00:00:00 2001 From: Leon Overweel Date: Sun, 12 Mar 2017 18:27:14 +0100 Subject: Add introduction to README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 13b436ac..d8ab48d5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # OpenDC Web Server +The OpenDC web server is the bridge between OpenDC's frontend and database. It is built with Flask/SocketIO in Python and implements the OpenAPI-compliant [OpenDC API specification](https://github.com/tudelft-atlarge/opendc/blob/master/opendc-api-spec.json). + ## Setup The following steps will guide you through setting up the OpenDC web server locally for development. To test individual endpoints, edit `static/index.html`. This guide was tested and developed on Windows 10. @@ -43,4 +45,4 @@ Run the server. ```bash python opendc-web-server/main.py config.json -``` \ No newline at end of file +``` -- cgit v1.2.3