From 0453b94eea1ebd902db193325d22229a3b3c551d Mon Sep 17 00:00:00 2001 From: Ryan Date: Tue, 13 Sep 2022 04:33:11 -0700 Subject: [PATCH] Recommend git dependency instead of path dependency in README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7772448..53edd92 100644 --- a/README.md +++ b/README.md @@ -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 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 -and add Valence as a [path dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies). +However, the crates.io version is likely outdated. To use the most recent development version, add Valence as a +[git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories) +. ```toml [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