From c643a793f2d1f3001c195142f980bd4eb069c485 Mon Sep 17 00:00:00 2001
From: Michal Badin <xbadin@fi.muni.cz>
Date: Fri, 5 May 2023 17:20:33 +0200
Subject: [PATCH] feat(README) : Updated README
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index 63ebe41..fc016db 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
# Formula team management
+## Navigation
+- [About Project](#about-project)
+- [Build and run the app](#build-and-run-the-app)
+- [Seed and clear DB](#seed-and-clear-db)
+- [Build and run the app with Docker](#build-and-run-the-app-with-docker)
+- [Collecting Metrics](#collecting-metrics)
+- [Grafana](#grafana)
+
## About Project
- **Name**: Formula One Team
@@ -36,6 +44,8 @@
3) Visualisation module:
<br>Visualization module provides a visualization of given JSON data in readable HTML (or other) format. Team manager
will be able to visualize current state of both cars.
+ <br> The result can be downloaded via Swagger UI or directly accessed in project the folder **output-data**, which is created
+ in case of missing.
4) Applications module:
<br>Applications module allows people to send an application to this team. Manager can view these applications and
hire new drivers for his team.
--
GitLab