feat(js): add README

This commit is contained in:
Erica Marigold 2024-06-19 18:09:25 +05:30
parent ac6f00a5c9
commit 531a9ffdf5
No known key found for this signature in database
GPG key ID: 2768CC0C23D245D1

View file

@ -0,0 +1,15 @@
# Deno/Node Packages
This package exports [lune](https://github.com/lune-org/lune), the standalone luau runtime as a JS package to be used as a dependency in a JS project.
To install the package, run one of the following in your project, substituting `{VERSION}` with the version of lune you want to install:
```sh
# Install from NPM for node
npm install lune@{VERSION}
# Install for Deno
deno install https://raw.githubusercontent.com/CompeyDev/lune-packaging/v{VERSION}/package/js/bin/lune.ts
```
> **Note**: Only lune versions starting from lune v0.8.5 are supported for NPM. Pinned deno versions are currently not supported, so you would need to omit the version portion from the script link.