From 3ac69631db9b44b1829e9735c2cb68e4c0a40b1f Mon Sep 17 00:00:00 2001
From: Erica Marigold <hi@devcomp.xyz>
Date: Sun, 26 May 2024 21:01:20 +0530
Subject: [PATCH] chore(README): include content

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

diff --git a/README.md b/README.md
index e69de29..23a0b61 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,29 @@
+<img align="right" height="250" width="250" src="src/main/resources/assets/elytra-lock/icon.png" />
+
+# elytra-lock
+
+<div>
+  <a href="https://modrinth.com/mod/touch-grass-reminder">
+    <img alt="modrinth" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg" />
+  </a>
+  <a href="https://quiltmc.org">
+    <img alt="quilt" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/quilt_vector.svg" />
+  </a>
+  <a href="https://fabricmc.net">
+    <img alt="quilt" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg" />
+  </a>
+</div>
+
+<br />
+
+A client-side fabric (quilt-compatible) mod which allows you to lock elytra functionality. 
+It registers a keybind (by default, `J`) which can be used to toggle the lock. 
+
+
+## Usage
+
+When locked, it is impossible to fly or equip the elytra with right-click - it is possible to 
+equip to it manually, by shift-clicking or dragging it onto the chestplate slot. If the
+elytra is locked when it is already equipped or equipped manually, flight is disabled.
+
+