Add readme

Lombra · Jul 30, 2024 · cf510a4 · cf510a4
1 parent 6a95e14
commit cf510a4
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# SpeedyGonzales
+
+Displays your current or maximum movement speed in a small standalone frame or via a LibDataBroker feed.
+
+### **Usage**
+- /speedy - Toggles the frame
+- /speedy config - Opens configuration window
+
+Absolute units are based on the following assumptions:
+
+- Base running speed is 7 yards per second.
+- 1 yard = 0.9144 meters.
+- 1 mile = 1760 yards.