Update ID Card system and readme

Byte-Labs-Studio · Mar 19, 2024 · 9dd8b03 · 9dd8b03
1 parent dfd2308
commit 9dd8b03
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/client/init.lua b/client/init.lua
@@ -84,4 +84,5 @@ RegisterKeyMapping('closeidcard', 'Close ID Card Popup', 'keyboard', config.popu
 RegisterNUICallback(Receive.loaded, function(_, cb)
     cb(1)
     SendNUIEvent(Send.config, config.idTypes)
-end)
+end)
+
diff --git a/readme.md b/readme.md
@@ -1,8 +1,30 @@
+# Byte Labs - ID Card
+A customisable system with an immaculate ID card design for your FiveM server.
 
+Website: [Byte Labs](https://byte-labs.net)
+Discord: [Byte Labs](https://discord.gg/fqsqSjZfxE)
 
+![Preview](https://i.imgur.com/JFZ4mc4.png)
+![Preview](https://i.imgur.com/k1zyqY0.png)
+![Preview](https://i.imgur.com/aZrl1dv.png)
+![Preview](https://i.imgur.com/XW0O2Xe.png)
 
+## Features
+- Customisable ID card design with a clean and modern look
 
-# OX Inventory
+## Dependencies
+- [bl_bridge](https://github.com/Byte-Labs-Project/bl_bridge)
+- [ox_lib](https://github.com/overextended/ox_lib)
+
+## Installation
+1. Download
+2. Extract the `bl_idcard` folder to your resources directory
+3. Add `ensure bl_idcard` to your server.cfg after bl_bridge
+4. Configure the `config.lua` to your liking
+
+
+## Items
+### OX Inventory
 ```lua
 	["id_card"] = {
 		label = "ID Card",
@@ -29,7 +51,7 @@
 	},
 ```
 
-## QB / QS / PS Inventory
+### QB / QS / PS Inventory
 ```lua
     ['id_card']  = {
         name = 'id_card',
-Original file line number
+Diff line change
@@ Expand Up @@
     RegisterNUICallback(Receive.loaded, function(_, cb)
         cb(1)
         SendNUIEvent(Send.config, config.idTypes)
-    end)
+    end)