@criticalred/crlib/README.md

JS/TS wrapper for crLib exports

# crLib JS/TS wrapper

Not all crLib functions found in Lua are supported, the ones that are will have a JS/TS example
on the documentation.

You still need to use and have the crLib resource included into the resource you are using the npm package in.

## Installation

```yaml
# With pnpm
pnpm add @overextended/crLib

# With Yarn
yarn add @overextended/crLib

# With npm
npm install @overextended/crLib
```

## 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/crLib/client'
```

```ts
import lib from '@overextended/crLib/server'
```

```ts
import { checkDependency } from '@overextended/crLib/shared';
```

## Documentation
[View documentation](https://overextended.github.io/docs/crLib)