mirror of
https://github.com/CompeyDev/bun-lune-loader.git
synced 2024-12-13 05:20:39 +00:00
chore(README): include barebones readme
This commit is contained in:
parent
c0c7f3851c
commit
777e38a1a4
1 changed files with 9 additions and 10 deletions
19
README.md
19
README.md
|
@ -1,16 +1,15 @@
|
||||||
# bun-luau-loader
|
# bun-luau-loader
|
||||||
|
|
||||||
To install dependencies:
|
Allows to import lua/luau files in TypeScript. Requires Lune.
|
||||||
|
|
||||||
```bash
|
```lua
|
||||||
bun install
|
-- module.luau
|
||||||
|
return {
|
||||||
|
SomeKey = "SomeValue"
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
To run:
|
```ts
|
||||||
|
// index.ts
|
||||||
```bash
|
import { SomeKey } from "./module.luau"
|
||||||
bun run src/index.ts
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This project was created using `bun init` in bun v1.0.0. [Bun](https://bun.sh)
|
|
||||||
is a fast all-in-one JavaScript runtime.
|
|
||||||
|
|
Loading…
Reference in a new issue