alex/valence
1
0
Fork 0
mirror of https://github.com/italicsjenga/valence.git synced 2025-01-25 21:26:32 +11:00
Code Issues Projects Releases Packages Wiki Activity

Recommend git dependency instead of path dependency in README.md

Browse source
This commit is contained in:
Ryan 2022-09-13 04:33:11 -07:00
parent 7878793629
commit 0453b94eea
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -63,15 +63,16 @@ If all goes well you should be playing on the server.
Valence is published to [crates.io](https://crates.io/crates/valence). Run `cargo add valence` to add it to your Valence is published to [crates.io](https://crates.io/crates/valence). Run `cargo add valence` to add it to your
project. Documentation is available [here](https://docs.rs/valence/latest/valence/). project. 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 However, the crates.io version is likely outdated. To use the most recent development version, add Valence as a
and add Valence as a [path dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies). [git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories)
.
```toml ```toml
[dependencies] [dependencies]
valence = { path = "the/path/to/valence" } valence = { git = "https://github.com/valence-rs/valence" }
``` ```
View the documentation by running `cargo d --open`. View the documentation by running `cargo d --open` in your project.
# Contributing # Contributing