update readme

2025-02-12 22:05:09 -05:00 · 2025-02-12 22:05:09 -05:00 · ebdcbb8b12
commit ebdcbb8b12
parent 9a800bb839
1 changed files with 22 additions and 0 deletions
--- 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