lune-packaging/package/js/README.md

20 lines
719 B
Markdown
Raw Normal View History

2024-06-19 13:39:25 +01:00
# 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.
2024-06-19 13:39:25 +01:00
To install the package, run one of the following in your project, substituting
`{VERSION}` with the version of lune you want to install:
2024-06-19 13:39:25 +01:00
```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 replace
> the version portion from the script link with main.