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