chore: update README
This commit is contained in:
parent
707b707f57
commit
8a23581f38
33
README.md
33
README.md
|
@ -1,3 +1,34 @@
|
|||
# busted-tl
|
||||
|
||||
Add Teal capabilities to Busted 🧙
|
||||
Add Teal capabilities to Busted 🧙
|
||||
|
||||
## Usage
|
||||
|
||||
First busted-tl needs to be installed. The most easy way to install is to use Luarocks:
|
||||
|
||||
```sh
|
||||
luarocks install busted-tl
|
||||
```
|
||||
|
||||
(Note: `busted-tl` depends on `busted`, so it will automatically be installed by Luarocks if it is missing)
|
||||
|
||||
Now, when running `busted` to allow the Teal loaders it must be specified with the `--loaders` flag:
|
||||
|
||||
```sh
|
||||
busted --loaders=teal
|
||||
```
|
||||
|
||||
When managing a project with Luarocks, it's easy to configure `busted-tl`:
|
||||
|
||||
```lua
|
||||
test_dependencies = {
|
||||
"busted-tl",
|
||||
}
|
||||
|
||||
test = {
|
||||
type = "busted",
|
||||
flags = {
|
||||
"--loaders=teal",
|
||||
},
|
||||
}
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue