Update README and bump version to 0.3
This commit is contained in:
parent
cbe3db5041
commit
fadfa4a2d3
|
@ -1,13 +1,13 @@
|
|||
[package]
|
||||
name = "mlua"
|
||||
version = "0.2.2"
|
||||
version = "0.3.0-alpha.1"
|
||||
authors = ["Aleksandr Orlenko <zxteam@pm.me>", "kyren <catherine@chucklefish.org>"]
|
||||
edition = "2018"
|
||||
repository = "https://github.com/khvzak/mlua"
|
||||
documentation = "https://docs.rs/mlua"
|
||||
readme = "README.md"
|
||||
keywords = ["lua", "luajit"]
|
||||
categories = ["api-bindings"]
|
||||
keywords = ["lua", "luajit", "async", "futures"]
|
||||
categories = ["api-bindings", "asynchronous"]
|
||||
license = "MIT"
|
||||
links = "lua"
|
||||
build = "build/main.rs"
|
||||
|
|
14
README.md
14
README.md
|
@ -18,6 +18,14 @@ modules in Rust.
|
|||
|
||||
## Usage
|
||||
|
||||
### Async
|
||||
|
||||
Starting from 0.3, mlua supports async/await for all Lua versions. This feature works using Lua [coroutines](https://www.lua.org/manual/5.3/manual.html#2.6) and require running [Thread](https://docs.rs/mlua/latest/mlua/struct.Thread.html).
|
||||
|
||||
**Examples**:
|
||||
- [HTTP Client](examples/async_http_client.rs)
|
||||
- [TCP Server](examples/async_tcp_server.rs)
|
||||
|
||||
### Choosing Lua version
|
||||
|
||||
The following features could be used to choose Lua version: `lua53` (default), `lua52`, `lua51` and `luajit`.
|
||||
|
@ -41,7 +49,7 @@ Add to `Cargo.toml` :
|
|||
|
||||
``` toml
|
||||
[dependencies]
|
||||
mlua = "0.2"
|
||||
mlua = "0.3"
|
||||
```
|
||||
|
||||
`main.rs`
|
||||
|
@ -73,8 +81,8 @@ Add to `Cargo.toml` :
|
|||
crate-type = ["cdylib"]
|
||||
|
||||
[dependencies]
|
||||
mlua = "0.2"
|
||||
mlua_derive = "0.2"
|
||||
mlua = "0.3"
|
||||
mlua_derive = "0.3"
|
||||
```
|
||||
|
||||
`lib.rs` :
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
[package]
|
||||
name = "mlua_derive"
|
||||
version = "0.2.0"
|
||||
authors = ["Aleksandr Orlenko <zxteam@protonmail.com>"]
|
||||
version = "0.3.0-alpha.1"
|
||||
authors = ["Aleksandr Orlenko <zxteam@pm.me>"]
|
||||
edition = "2018"
|
||||
description = "Procedural macros for the mlua crate."
|
||||
repository = "https://github.com/khvzak/mlua"
|
||||
|
|
Loading…
Reference in a new issue