chore(README): include barebones readme

This commit is contained in:
Erica Marigold 2023-09-25 19:25:39 +05:30
parent c0c7f3851c
commit 777e38a1a4

View file

@ -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.