Skip to content

Commit db42c36

Browse files
authored
Update README.md
1 parent 45fc209 commit db42c36

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TypescriptToLua
1+
# TypeScriptToLua
22
A generic TypeScript to Lua transpiler. Write your code in TypeScript and publish Lua!
33

44
Large projects written in lua can become hard to maintain and make it easy to make mistakes. Writing code in TypeScript instead improves maintainability, readability and robustness, with the added bonus of good IDE support. This project is useful in any environment where Lua code is accepted, with the powerful option of simply declaring any existing API using TypeScript declaration files.
@@ -7,7 +7,7 @@ Large projects written in lua can become hard to maintain and make it easy to ma
77
[![Build status](https://ci.appveyor.com/api/projects/status/github/perryvw/typescripttolua?branch=master&svg=true)](https://ci.appveyor.com/project/Perryvw/typescripttolua)
88
[![Coverage](https://codecov.io/gh/perryvw/typescripttolua/branch/master/graph/badge.svg)](https://codecov.io/gh/perryvw/typescripttolua)
99

10-
You can chat with us on Discord: [![Discord](https://img.shields.io/discord/515854149821267971.svg)](https://discord.gg/BWAq58Y)
10+
You can chat with us on [Discord: ![Discord](https://img.shields.io/discord/515854149821267971.svg)](https://discord.gg/BWAq58Y)
1111

1212
## Documentation
1313
More detailed documentation and info on writing declarations can be found [on the wiki](https://github.com/Perryvw/TypescriptToLua/wiki).
@@ -28,6 +28,10 @@ Changelog can be found in [CHANGELOG.md](https://github.com/Perryvw/TypescriptTo
2828

2929
`tstl -p path/to/tsconfig.json`
3030

31+
**Compile project in watch mode**
32+
33+
`tstl -p path/to/tsconfig.json --watch`
34+
3135
**Example tsconfig.json**
3236
```
3337
{

0 commit comments

Comments
 (0)