chore(readme): re-wrote

Added description, image qbox logo, and more useful info
2023-11-09 22:50:57 -08:00
parent 75d54d7df5
commit f6793b1c22
1 changed files with 43 additions and 1 deletions
@@ -1,2 +1,44 @@
+![image](https://github.com/Qbox-project/qbx_divegear/assets/85725579/935bdf83-5cd7-4d6a-8818-0359b41032d2)
+
 # qbx_divegear
-Items to help players breathe &amp; move underwater
+
+A Qbox resource that enables the functionality of diving and air tank items. 
+
+Works with [qbx_diving](https://github.com/Qbox-project/qbx_diving/), a coral diving and collection resource, also developed by the Qbox community!
+
+# Features
+
+- Able to set the length of time an air tank will refill your tank
+- Limitations for refilling underwater (to limit endless use of air tanks)
+- animations and timers during refill
+- Text that displays current air time at the bottom of the player's screen when underwater and wearing gear
+
+# ox_inventory items
+
+Place these items in ox_inventory's item.lua if you don't have them already:
+
+```
+    ['diving_fill'] = {
+        label = 'Diving Tube',
+        weight = 3000,
+        stack = false,
+        close = true,
+        description = "used to refill your diving gear's oxygen supply."
+    },
+
+    ['diving_gear'] = {
+        label = 'Diving Gear',
+        weight = 30000,
+        stack = false,
+        close = true,
+        description = "A diving set that let's swim underwater. Blub blub!"
+    },
+
+```
+
+# ox_inventory images
+
+Missing images for your items? Here are some free-to-use images!
+
+![diving_gear](https://github.com/Qbox-project/qbx_divegear/assets/85725579/739d847c-1b49-4c20-9578-6e5ec8eac179)
+![diving_fill](https://github.com/Qbox-project/qbx_divegear/assets/85725579/62c9057d-9412-4256-aab4-59cfe015e90b)