From da4504caf01bdfdfbc4e031e9e7061e5817011c1 Mon Sep 17 00:00:00 2001 From: javalikescript Date: Sat, 3 Jun 2023 17:31:53 +0200 Subject: [PATCH] Update readme --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3961a53..5b2d524 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ +
+ +• +[User manual](https://github.com/javalikescript/luajls/blob/master/doc_topics/manual.md) +• +[API documentation](https://javalikescript.github.io/luajls/) +• +[Download binaries](https://github.com/javalikescript/luajls/releases/latest) +• + +
+ + ## What is luajls? luajls is a set of Lua modules for developing stand-alone [Lua](https://www.lua.org/) applications. @@ -67,7 +80,7 @@ event:loop() Just drop the *jls* folder in your Lua path. -The only required dependency is Lua 5.4. +The only required dependency is Lua. Optional dependencies are C-based or plain Lua modules such as *luafilesystem*, *luasocket*, *luv*, *lua-openssl*, *lua-cjson*. By example, the file system manipulation requires one of the *luafilesystem* or the *luv* dependent module. The recommended dependency is *luv* as it will provide you a uniform support of the *io*, *lang* and *net* packages. @@ -84,6 +97,13 @@ winget install luajls luajls is also available on [LuaRocks](https://luarocks.org/modules/javalikescript/luajls). +## What are the supported Lua versions? + +The only fully supported version is the latest, currently Lua 5.4. + +In order to support the majority of Lua engines, an effort is made to provide a good level of compatibility for Lua 5.1 and LuaJIT. + + ## What do you want to do? Browse the [examples](https://github.com/javalikescript/luajls/tree/master/examples)