From 145404d82926501f9bc8f513bce6aeacbe5d451c Mon Sep 17 00:00:00 2001
From: Jake <72943190+shv187@users.noreply.github.com>
Date: Sat, 7 Feb 2026 04:48:17 +0100
Subject: [PATCH] Update README

Added project description, usage instructions, and sidenotes to README.
---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f87f5c1..72ae7b3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
-# TODO
\ No newline at end of file
+# ZUTUI
+##### Have you ever felt like visiting https://edziekanat.zut.edu.pl/ is quite annoying?
+
+##### Wouldn't you rather stay in your terminal? Everyone loves terminals...
+
+##### At least I did.
+
+# So here we go!
+<img width="100%" height="auto" alt="Login Page" src="https://github.com/user-attachments/assets/081d30f1-75f6-42e4-adbe-c3d67f2ea69c" />
+<img width="100%" height="auto" alt="Grades Page" src="https://github.com/user-attachments/assets/6536c74d-13a5-436e-af3d-5522216ce8c1" />
+
+# Usage
+### 1. Download:
+```
+pip install git+https://github.com/shv187/zutui.git
+```
+### 2. Start:
+```
+zutui
+```
+### 3. Enjoy :)
+
+# Sidenotes
+- config is stored @ `~/zutui/config.json`
+- so are `grades_cache.json`
+- in plaintext.....
+
+##### As of right now I don't see any MUCH better way.
+
+##### I mean we could simply encrypt and decrypt it during runtime, but... does it really make it any more secure?
+
+##### And we can't really store it in any form of a _hash_ as we have to log in everytime with plain text anyways...
+
+##### However feel free to pull request if you're smarter :)
+
+# TODO:
+- [x] **Nothing**
+- [ ] Open for **requests** tho...
+- [ ] And mostlikely **issues** too...