From c133cf7fa83c3a87008fd5e2bec733e937a0aeb1 Mon Sep 17 00:00:00 2001 From: cyclic Date: Thu, 18 Sep 2025 10:16:20 -0600 Subject: [PATCH] updated readme with basic info --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5fc05c7..b5378dd 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -refer to https://git.luau.software/luau.software/moana \ No newline at end of file +# 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 \ No newline at end of file