alex/valence
1
0
Fork 0
mirror of https://github.com/italicsjenga/valence.git synced 2024-12-23 14:31:30 +11:00
Code Issues Packages Projects Releases Wiki Activity

Clarify status of crates.io crate in the readme

Browse source
This commit is contained in:
Ryan Johnson 2022-09-06 18:05:57 -07:00 committed by GitHub
parent 6215373b18
commit ce02b50623
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -61,9 +61,17 @@ If all goes well you should be playing on the server.
## Adding Valence as a Dependency
Valence is published to [crates.io](https://crates.io/crates/valence). Run `cargo add valence` to add it to your
project.
project. Documentation is available [here](https://docs.rs/valence/latest/valence/).
Documentation is available [here](https://docs.rs/valence/latest/valence/).
However, the crates.io version is likely outdated. To use the most recent development version, clone the repo
and add Valence as a [path dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies).
```toml
[dependencies]
valence = { path = "the/path/to/valence" }
```
View the documentation by running `cargo d --open`.
# Contributing