From 34cc55a0fe7e10e12cabac4654898762095b6043 Mon Sep 17 00:00:00 2001 From: unwox Date: Sun, 26 Jan 2025 12:31:08 +0600 Subject: fix small typos in READM --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9d28037..e901897 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,16 @@ following key features: * sqlite3 for data storage * asynchronous I/O operations * small and maintainable codebase -* handles relatively high number of requests per second +* relatively high number of handled requests per second See an [example site](https://git.sr.ht/~unwox/luna/tree/master/item/example). +To start it run `./run.sh serve` in the `example` example directory. ## Build -You'll need `lua` or `luajit` libraries installed on your system: +You'll need `go`, `gcc` and `liblua` (or `libluajit`) packages installed on +your system: ```sh git clone https://git.sr.ht/~unwox/luna @@ -42,7 +44,7 @@ luna [options] LUAFILE Number of HTTP-workers to start (default $(nproc)) ``` -LUAFILE must specify a Lua file that may or may not register routes to handle +LUAFILE must point to a Lua file that may or may not register routes to handle (via calling `luna.route.static` or `luna.route.route`). Whatever the LUAFILE returns is ignored. If LUAFILE defines no routes luna will execute the file and then exit. This behavior is useful when you want to have a script file with an @@ -62,7 +64,7 @@ API names are hyphenated since I am mostly calling the functions from [fennel language](https://fennel-lang.org/) and for lisps hyphenation is the norm. -Every argument in every API function is required: luna does not support optinal +Every argument in every API function is required: luna does not support optional arguments yet. Pass an empty value for corresponding type instead if you do not want to specify an argument: {} for tables, "" for strings, 0 for numbers. @@ -254,9 +256,9 @@ Send patches to me@unwox.com. Possible ideas for patches are * adding more *useful* API functions. It's easy to do, see `main.go` for that. * replacing sqlite with something else since its sqlite3_step function is blocking and it's the major perfomance bottleneck right now. -* supporting redis for synchronization, maybe? -* supporting websocket connections, maybe? -* compiling Lua code and luna into one binary, maybe? +* supporting redis for synchronization maybe? +* supporting websocket connections maybe? +* compiling Lua code and luna into one binary maybe? I will not accept patches that are @@ -264,7 +266,7 @@ I will not accept patches that are * relying on too many Go (or external) dependencies. * adding too much complexity into the existing codebase. * adding a new major functionality that should be implemented outside - (for example service management, use systemd, shepher or whatever). + (for example service management, use systemd, shepherd or whatever). ## Useful links -- cgit v1.2.3