From 512a5cc4142cf3ae5046152675b49394b8bd9cd2 Mon Sep 17 00:00:00 2001
From: marco <marco@skup.in>
Date: Tue, 28 Jan 2025 23:17:57 +0100
Subject: [PATCH] Added readme.md

---
 readme.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..ff7c290
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,45 @@
+# Floodwatch
+This App was build for demonstration purposes.
+It requests data from the Environment Agency Real Time flood-monitoring API and displays a list and map of all flood measurement stations,
+as well as a graph showing the last 24 hours of measurements.
+
+## Features
+
+- **Interactive Map View**: Uses OpenStreetMap to display all flood monitoring stations
+
+- **Station List**:
+ - Complete list of all flood monitoring stations
+ - Fltering by station label
+ 
+- **Detailed Station View**:
+ - Line graphs showing water levels over the past 24 hours
+
+## Third-Party Packages used
+
+- **provider**: State management solution for handling station data
+- **flutter_map**: Integration with OpenStreetMap for the map view
+- **fl_chart**: Creating line graphs for water levels
+
+## Installation
+
+1. Clone the repository:
+```bash
+git clone https://github.com/yourusername/floodwatch.git
+```
+2. Install dependencies:
+```bash
+flutter pub get
+```
+
+3. Run the app:
+```bash
+flutter run
+```
+
+The App has been tested on Linux and Web and can be tested on android, too.
+
+## Building release version
+
+```bash
+flutter build
+```
\ No newline at end of file