From 777e38a1a4b7125351f1271dce0aff31ec70f204 Mon Sep 17 00:00:00 2001 From: Erica Marigold Date: Mon, 25 Sep 2023 19:25:39 +0530 Subject: [PATCH] chore(README): include barebones readme --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f93cbee..e0ccb8a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ # bun-luau-loader -To install dependencies: +Allows to import lua/luau files in TypeScript. Requires Lune. -```bash -bun install +```lua +-- module.luau +return { + SomeKey = "SomeValue" +} ``` -To run: - -```bash -bun run src/index.ts +```ts +// index.ts +import { SomeKey } from "./module.luau" ``` - -This project was created using `bun init` in bun v1.0.0. [Bun](https://bun.sh) -is a fast all-in-one JavaScript runtime.