From 158ec03a2abda66c34be33c60a2623e3be8d8acc Mon Sep 17 00:00:00 2001
From: Luke <sabolukas03@gmail.com>
Date: Sun, 18 Sep 2022 12:37:03 +0200
Subject: [PATCH] chore(package): add readme

---
 package/README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 package/README.md

diff --git a/package/README.md b/package/README.md
new file mode 100644
index 0000000..46347f3
--- /dev/null
+++ b/package/README.md
@@ -0,0 +1,39 @@
+# ox_lib JS/TS wrapper
+
+Not all ox_lib functions found in Lua are supported, the ones that are will have a JS/TS example
+on the documentation.
+
+Currently, all the available functions for JS/TS can be found under the `resource` folder in  
+ox_lib.
+
+## Installation
+
+```yaml
+# With pnpm
+pnpm add @overextended/ox_lib
+
+# With Yarn
+yarn add @overextended/ox_lib
+
+# With npm
+npm install @overextended/ox_lib
+```
+
+## Usage
+You can either import the lib from client or server files or deconstruct the object and import only certain functions
+you may require.
+
+```ts
+import lib from '@overextended/ox_lib/client'
+```
+
+```ts
+import lib from '@overextended/ox_lib/server'
+```
+
+```ts
+import { checkDependency } from '@overextended/ox_lib/shared';
+```
+
+## Documentation
+[View documentation](https://overextended.github.io/docs/ox_lib)
\ No newline at end of file