Skip to content

Commit e90e8c1

Browse files
committed
Prepare Readme for RC release
1 parent 24dfff6 commit e90e8c1

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,38 +30,38 @@ The bindings do _**not**_ support in-development Godot 4 versions at the moment.
3030

3131
Detailed setup is explained in [the _Getting Started_ section of the book](https://godot-rust.github.io/book/getting-started.html). In case of problems, consider also reading the [FAQ](https://godot-rust.github.io/book/faq/configuration.html).
3232

33-
### Latest `master` version + Godot 3.4
33+
### Latest released version
3434

35-
This is the recommended way of using godot-rust, if you want to benefit from latest features.
36-
After `bindgen` dependencies are installed, add the `gdnative` crate as a dependency, and set the crate type to `cdylib`:
35+
This is the recommended way of using godot-rust. After `bindgen` dependencies and a current Godot version are installed, add the `gdnative` crate as a dependency, and set the crate type to `cdylib`:
3736

3837
```toml
3938
[dependencies]
40-
gdnative = { git = "https://github.com/godot-rust/godot-rust.git" }
39+
gdnative = "0.10.0-rc.0"
4140

4241
[lib]
4342
crate-type = ["cdylib"]
4443
```
4544

46-
### Godot 3.2.3-stable
45+
### Latest GitHub version
4746

48-
To access the last released version on crates.io, use the following. Note that there have been significant API changes since v0.9.3 -- if you are starting to use godot-rust, we recommend using the `master` version instead.
47+
If you would like to benefit from cutting-edge features and bugfixes, you can use the GitHub version. We have a relatively sophisticated CI and test suite for basic stability, but the GitHub version is typically more experimental and less battle-tested than a `crates.io` release. We also do not guarantee any SemVer compatibility here.
4948

5049
```toml
5150
[dependencies]
52-
gdnative = "0.9.3"
51+
gdnative = { git = "https://github.com/godot-rust/godot-rust.git" }
5352

5453
[lib]
5554
crate-type = ["cdylib"]
5655
```
5756

57+
5858
### Custom builds
5959

6060
To use the bindings with a different Godot version or a custom build of the engine, see [Custom Godot builds](https://godot-rust.github.io/book/advanced-guides/custom-godot.html) in the user guide.
6161

62-
### Async / `yield` support
62+
### Async/yield support
6363

64-
Async support is a work-in-progress, with a low-level API available in the `gdnative-async` crate. This crate is re-exported as `gdnative::tasks`, if the `async` feature is enabled on `gdnative`. See [this page](https://godot-rust.github.io/book/recipes/async-tokio.html) in the book for an introduction to use the async feature with Tokio.
64+
Async support is a work-in-progress, with a low-level API available in `gdnative::tasks`, if the `async` feature is enabled on `gdnative`. See [this page](https://godot-rust.github.io/book/recipes/async-tokio.html) in the book for an introduction to use the async feature with Tokio.
6565

6666
## Example
6767

0 commit comments

Comments
 (0)