From ebdcbb8b12e65c3dfb39abb43c93a8c2fa7a5cbf Mon Sep 17 00:00:00 2001
From: ultrablob <neelgillshah@gmail.com>
Date: Wed, 12 Feb 2025 22:05:09 -0500
Subject: [PATCH] update readme

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 4168463..e7b4556 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,25 @@
 
 # Jarvis Assistant for Marvel Rivals
 
+A simple piece of software i cooked up in a few hours because it would be funny
+
+### Setup
+
+```
+uv sync # sync dependencies (setup only)
+```
+
+### Usage
+
+```
+uv run main.py
+```
+
+Press the hotkey (default is Home) and then talk to jarvis
+
+### Supported Commands
+
+- say something in team/match chat
+- maximum pulse
+
+Checkout the code to see specific keywords/phrases as all NLP is regex/string based, not generative AI
\ No newline at end of file