Update README

Author: Andreas-Menzel

README.md

@@ -1,2 +1,71 @@
-# ADDS-ControlPanel
-The user interface for the Autonomous Drone Delivery System.
+# ADDS ControlPanel
+
+## Visualize blackbox data and more from your ADDS drone fleet
+
+ADDS-ControlPanel can visualize your drone's data like GPS-location,
+takeoff / landing location, altitude, velocity, battery state of charge and
+much more. Show live-data or check flight parameters of previous flights with
+an interactive OSM map and simple data charts.
+
+**Note:** ADDS-TrafficControl is needed as the data management system.
+
+## Setup
+
+Clone the repository:
+
+```bash
+git clone https://github.com/Andreas-Menzel/ADDS-ControlPanel.git
+```
+
+Update the URL to your Traffic Control instance by changing the
+`trafficControlUrl` constant in `/app/js/main.js`:
+
+```javascript
+const trafficControlUrl = 'http://adds-demo.an-men.de/';
+```
+
+Open the website (/app/index.html). Currently no server-side features are
+implemented, so an installation on a web-server on not necessary.
+
+## Applets
+
+The application consists of multiple applets. Each applet can visualize a
+specific dataset. Adding or removing drones from the list in the main script
+results in all applets automatically updating.
+
+### MapApplet
+
+Shows an interactive map using OpenStreetMaps to visualize the position of each
+drone, takeoff and landing site. The map automatically adjusts the center and
+zoom-level to the position of all drones currently active, so everything of
+interest is visible all the time.
+
+![MapApplet](images/MapApplet.png)
+
+### DroneAltitudeApplet
+
+Shows the altitude of each drone using a bar graph. Simple, but effective.
+
+![DroneAltitudeApplet](images/DroneAltitudeApplet.png)
+
+### DroneVelocityApplet
+
+Shows the velocity of each drone using a bar graph. Switching between the
+NED (North-East-Down) and NWU (North-West-Up) system is possible. You can also
+change the unit from m/s to km/h.
+
+![DroneVelocityApplet](images/DroneVelocityApplet.png)
+
+### DroneSoCApplet
+
+Shows the batteries state of charge of each drone using bar graphs. The bars
+become orange on < 40% soc and red on < 20% soc.
+
+![DroneSoCApplet](images/DroneSoCApplet.png)
+
+### DroneRemDistApplet
+
+Shows the remaining flight radius of each drone using bar graphs. The bars
+become orange on < 2km range and red on < 1 km range.
+
+![DroneRemDistApplet](images/DroneRemDistApplet.png)