From 83e08bd28653e5cd19a2c342c1d8c97e3b77b3d7 Mon Sep 17 00:00:00 2001
From: Noza23 <G.Nozadze@campus.lmu.de>
Date: Sun, 25 Feb 2024 00:04:20 +0100
Subject: [PATCH] feat: readme

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8c9a95e..b154eba 100644
--- a/README.md
+++ b/README.md
@@ -4,5 +4,52 @@
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 ## Description
-This repostiory contains the code for the myovision web-app, which is a sub-project of the main project [myovision](https://github.com/Noza23/myovision).
-It allows the users to use the myovision conveniently ...
+
+This is a sub-project of the main project [myovision](https://github.com/Noza23/myovision).
+It provides a Backend for the Application developed for the convenient use and further development of the myovision project.
+It is a RESTful API developed with the FastAPI framework and has a designated Frontend for the user interaction [myovision-app-front](https://github.com/davitchanturia/myovision-app-front)
+
+With a slight modification the Backend can be generalized and used for any computer vision project concerning instance segmentation.
+
+## Contact Information
+
+The Backend as well as the Frontend won't be published open-source for now, Contact the maintainer for the further information or if you are interested in the project.
+
+```json
+{
+    name = "Giorgi Nozadze",
+    email = "giorginozadze23@yahoo.com"
+}
+```
+
+## Visualizations
+
+- Annotation Tool for collecting labeled data
+  ![caption](https://drive.google.com/file/d/1VyDfBLxYYHkPoBV11wJ4LO1NqtcXED38/view?usp=sharing)
+  [Video](https://drive.google.com/file/d/1JFWEre71lWuu_wAtUcogsJ7cMXfV57Or/view?usp=sharing)
+
+- Inference Tool for observing model's predictions and relevant metrics
+  ![caption](https://drive.google.com/file/d/1YnVX93IUUciRpEoDXEf9SXjGfiDVMBXE/view?usp=sharing)
+  [Video](https://drive.google.com/file/d/1JFWEre71lWuu_wAtUcogsJ7cMXfV57Or/view?usp=sharing)
+
+# Installation
+
+- Local Setup
+
+```bash
+mv .env.example .env
+uvicorn backend.main:app --reload
+```
+
+- Docker Build
+
+```bash
+docker build -t myovision-app .
+docker run -d --name myovision-app -p 8000:8000 myovision-app
+```
+
+- Docker Compose
+
+```bash
+docker-compose up -d
+```