diff --git a/NOTICE.md b/NOTICE.md new file mode 100644 index 0000000..46c36d5 --- /dev/null +++ b/NOTICE.md @@ -0,0 +1,23 @@ +## Copyright + +Copyright © 2025 Overextended + +Use of this code is subject to the terms and conditions of the license, as stated below. + +## Licensing and Attribution + +This project is licensed under the [LGPL‑3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html) or any later version. + +A complete copy of the license is included in the [LICENSE](./LICENSE) file. + +When incorporating this work into your own project, you must: + +- Clearly credit the original authors and provide a link to the original project. +- Document any modifications made to the original work. +- Include the full text of the LGPL‑3.0 license with your distribution. +- Ensure that your project remains available under the LGPL‑3.0 or a compatible open-source license. +- Preserve all existing copyright and licensing notices. + +## Source Code + +The original source code is available at: [https://github.com/overextended/ox_lib](https://github.com/overextended/ox_lib) diff --git a/README.md b/README.md index 9142ea5..aa15bc9 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,12 @@ A FiveM library and resource implementing reusable modules, methods, and UI elem ![](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) +![](https://img.shields.io/github/v/release/overextended/ox_lib?logo=github) + +For guidelines to contributing to the project, and to see our Contributor License Agreement, see [CONTRIBUTING.md](./CONTRIBUTING.md) + +For additional legal notices, refer to [NOTICE.md](./NOTICE.md). + ## 📚 Documentation @@ -15,11 +20,11 @@ https://overextended.dev/ox_lib https://github.com/overextended/ox_lib/releases/latest/download/ox_lib.zip -## npm Package +## 📦 npm package https://www.npmjs.com/package/@overextended/ox_lib -## Lua Language Server +## 🖥️ 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.