forked from cyclic/moana
updated readme with basic info
This commit is contained in:
19
README.md
19
README.md
@@ -1 +1,18 @@
|
||||
refer to https://git.luau.software/luau.software/moana
|
||||
# Moana
|
||||
|
||||
A lightweight HTTP router and server framework for Luau.
|
||||
|
||||
## Installation
|
||||
|
||||
Clone the Git repo (`git clone https://git.luau.software/luau.software/moana`) and install [Lune](https://lune-org.github.io/docs/) via [Rokit](https://github.com/rojo-rbx/rokit) (`rokit install`)
|
||||
|
||||
## Usage
|
||||
|
||||
Refer to `test.luau` as well as `benchmark.luau` for real implementations to use as a reference.
|
||||
Most of the project is fully typechecked, so the usage APIs should be pretty clear.
|
||||
|
||||
Run tests with `lune run test`.
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
Reference in New Issue
Block a user