Skip to content

Commit 8677b57

Browse files
committed
Update README
1 parent 7543b06 commit 8677b57

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,21 @@ WebAssembly (WASM) is supported through `wasm32-unknown-emscripten` target for a
3838
`mlua` uses feature flags to reduce the amount of dependencies, compiled code and allow to choose only required set of features.
3939
Below is a list of the available feature flags. By default `mlua` does not enable any features.
4040

41-
* `lua54`: activate Lua [5.4] support
42-
* `lua53`: activate Lua [5.3] support
43-
* `lua52`: activate Lua [5.2] support
44-
* `lua51`: activate Lua [5.1] support
45-
* `luajit`: activate [LuaJIT] support
46-
* `luajit52`: activate [LuaJIT] support with partial compatibility with Lua 5.2
47-
* `luau`: activate [Luau] support (auto vendored mode)
48-
* `luau-jit`: activate [Luau] support with JIT backend.
49-
* `luau-vector4`: activate [Luau] support with 4-dimensional vector.
41+
* `lua54`: enable Lua [5.4] support
42+
* `lua53`: enable Lua [5.3] support
43+
* `lua52`: enable Lua [5.2] support
44+
* `lua51`: enable Lua [5.1] support
45+
* `luajit`: enable [LuaJIT] support
46+
* `luajit52`: enable [LuaJIT] support with partial compatibility with Lua 5.2
47+
* `luau`: enable [Luau] support (auto vendored mode)
48+
* `luau-jit`: enable [Luau] support with JIT backend.
49+
* `luau-vector4`: enable [Luau] support with 4-dimensional vector.
5050
* `vendored`: build static Lua(JIT) library from sources during `mlua` compilation using [lua-src] or [luajit-src] crates
5151
* `module`: enable module mode (building loadable `cdylib` library for Lua)
5252
* `async`: enable async/await support (any executor can be used, eg. [tokio] or [async-std])
53-
* `send`: make `mlua::Lua` transferable across thread boundaries (adds [`Send`] requirement to `mlua::Function` and `mlua::UserData`)
53+
* `send`: make `mlua::Lua: Send + Sync` (adds [`Send`] requirement to `mlua::Function` and `mlua::UserData`)
5454
* `serialize`: add serialization and deserialization support to `mlua` types using [serde] framework
5555
* `macros`: enable procedural macros (such as `chunk!`)
56-
* `parking_lot`: support UserData types wrapped in [parking_lot]'s primitives (`Arc<Mutex>` and `Arc<RwLock>`)
5756

5857
[5.4]: https://www.lua.org/manual/5.4/manual.html
5958
[5.3]: https://www.lua.org/manual/5.3/manual.html
@@ -67,7 +66,6 @@ Below is a list of the available feature flags. By default `mlua` does not enabl
6766
[async-std]: https://github.com/async-rs/async-std
6867
[`Send`]: https://doc.rust-lang.org/std/marker/trait.Send.html
6968
[serde]: https://github.com/serde-rs/serde
70-
[parking_lot]: https://github.com/Amanieu/parking_lot
7169

7270
### Async/await support
7371

@@ -91,7 +89,7 @@ cargo run --example async_http_client --features=lua54,async,macros
9189
cargo run --example async_http_reqwest --features=lua54,async,macros,serialize
9290

9391
# async http server
94-
cargo run --example async_http_server --features=lua54,async,macros
92+
cargo run --example async_http_server --features=lua54,async,macros,send
9593
curl -v http://localhost:3000
9694
```
9795

0 commit comments

Comments
 (0)