From 497bee836fe826fbf17bd5e91d500d22d149b04d Mon Sep 17 00:00:00 2001 From: Linden <65407488+thelindat@users.noreply.github.com> Date: Sat, 29 Jul 2023 07:52:49 +1000 Subject: [PATCH] chore: update readme --- README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 02479fc..9142ea5 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,27 @@ -

Documentation

-
+# ox_lib -## ox_lib +A FiveM library and resource implementing reusable modules, methods, and UI elements. -Cfx provides functionality for loading external files in a resource through fxmanifest. +![](https://img.shields.io/github/downloads/overextended/ox_lib/total?logo=github) +![](https://img.shields.io/github/downloads/overextended/ox_lib/latest/total?logo=github) +![](https://img.shields.io/github/contributors/overextended/ox_lib?logo=github) +![](https://img.shields.io/github/v/release/overextended/ox_lib?logo=github) -```lua -lua54 'yes' -shared_script '@ox_lib/init.lua' -``` +## 📚 Documentation -### server.cfg +https://overextended.dev/ox_lib -``` -add_ace resource.ox_lib command.add_ace allow -add_ace resource.ox_lib command.remove_ace allow -add_ace resource.ox_lib command.add_principal allow -add_ace resource.ox_lib command.remove_principal allow -``` +## 💾 Download -## License +https://github.com/overextended/ox_lib/releases/latest/download/ox_lib.zip -LGPL-3.0-or-later +## npm Package + +https://www.npmjs.com/package/@overextended/ox_lib ## Lua Language Server - Install [Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) to ease development with annotations, type checking, diagnostics, and more. - Install [cfxlua-vscode](https://marketplace.visualstudio.com/items?itemName=overextended.cfxlua-vscode) to add natives and cfxlua runtime declarations to LLS. - You can load ox_lib into your global development environment by modifying workspace/user settings "Lua.workspace.library" with the resource path. - - e.g. "c:\\fxserver\\resources\\ox_lib" + - e.g. "c:/fxserver/resources/ox_lib"