From 59b05ac8425e34cdf41179506cdda357c59b4b12 Mon Sep 17 00:00:00 2001 From: Leon Overweel Date: Mon, 27 Mar 2017 17:31:31 +0200 Subject: Add section jumps to README --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index d38f998e..187d4133 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,10 @@ 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/atlarge-research/opendc/blob/master/opendc-api-spec.json). -This document describes how to set up the web server for local development, and explains a high-level view of the web server architecture. +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)). ## Architecture - The following diagram shows a high-level view of the architecture of the OpenDC web server. Squared-off colored boxes indicate packages (colors become more saturated as packages are nested); rounded-off boxes indicate individual components; dotted lines indicate control flow; and solid lines indicate data flow. ![OpenDC Web Server Component Diagram](https://raw.githubusercontent.com/atlarge-research/opendc-web-server/master/images/opendc-web-server-component-diagram.png) -- cgit v1.2.3