diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2021-04-08 20:59:35 +0200 |
|---|---|---|
| committer | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2021-05-03 20:15:54 +0200 |
| commit | 8f75336cb802b770d1ac53efb155632dd2dd94d2 (patch) | |
| tree | 0bbd69ee21a1d180dd9ad6583a736de31335cc25 /opendc-web/opendc-web-api/README.md | |
| parent | 128f76f7fd7c8abb41a3bbbd9f1980cbc20ae7a5 (diff) | |
docs: Revamp project documentation
This change updates the project documentation by moving most of the
documentation to the docs directory.
Diffstat (limited to 'opendc-web/opendc-web-api/README.md')
| -rw-r--r-- | opendc-web/opendc-web-api/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/opendc-web/opendc-web-api/README.md b/opendc-web/opendc-web-api/README.md index 182cd803..4932f823 100644 --- a/opendc-web/opendc-web-api/README.md +++ b/opendc-web/opendc-web-api/README.md @@ -1,5 +1,5 @@ <h1 align="center"> - <img src="../misc/artwork/logo.png" width="100" alt="OpenDC"> + <img src="../../docs/images/logo.png" width="100" alt="OpenDC"> <br> OpenDC Web Server </h1> @@ -9,7 +9,7 @@ <br> -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](../opendc-api-spec.yml). +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](../../opendc-api-spec.yml). This document explains a high-level view of the web server architecture ([jump](#architecture)), and describes how to set up the web server for local development ([jump](#setup-for-local-development)). |