From 171e3c81aaf735cc450fda3d48efd22717de95d5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Taha=20=C3=9Cz=C3=BCmc=C3=BC?=
 <36675318+kinkintama@users.noreply.github.com>
Date: Sat, 28 May 2022 22:36:38 +0300
Subject: [PATCH] add readme.md

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ceebfeb..c3cb0a2 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,25 @@
-# Deneyap-Kart-Web-Agent
\ No newline at end of file
+# Deneyap-Kart-Web-Agent
+
+## Summary
+
+This project is made for https://deneyapkart.org/deneyapkart/deneyapblok/
+
+It uses arduino-cli to interract with Deneyap Kart/Mini.
+
+Basicly this program uses websockets to connect websites front end communicates with it, parses information and utilizes arduino-cli.
+
+Can be modified for other hardwares just as esp and arduino.
+
+Front-end code is blockWebsocket.js file.
+
+## How To Run
+You can basicly download .exe from last release or
+
+Use the package manager [pip](https://pip.pypa.io/en/stable/) to install requirements.
+```bash
+pip install -r requirements
+```
+then
+```bash
+python main.py
+```
\ No newline at end of file