From 531a9ffdf515b104f30f0cbccef5e1696f4dcb8b Mon Sep 17 00:00:00 2001
From: Erica Marigold <hi@devcomp.xyz>
Date: Wed, 19 Jun 2024 18:09:25 +0530
Subject: [PATCH] feat(js): add README

---
 package/js/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/package/js/README.md b/package/js/README.md
index e69de29..53acf8c 100644
--- a/package/js/README.md
+++ b/package/js/README.md
@@ -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.