From 1b898adeeb4cb01bdc86de6b70293ec8ae00dd4d Mon Sep 17 00:00:00 2001 From: Michel de Graaf Date: Thu, 10 Sep 2026 12:08:00 +0200 Subject: [PATCH] docs: stop pinning a library version the instructions cannot keep current MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Four places told people to write `soulseek-rs-lib = "8"` (RELEASE.md said "6"), and every one of them had been left behind by ten majors or more. The failure is silent rather than loud: 6.x and 8.0.0 are both real published versions, so cargo resolves the snippet happily and hands over a library from August instead of refusing it, and one of the four is soulseek-rs-lib's own README, which is the page crates.io renders. `cargo add` writes whatever version is current at the time it runs, so there is no longer a number in the docs to go stale. The manifest pin in soulseek-rs/Cargo.toml stays as it is — release-plz owns that one and keeps it in step with the release. --- README.md | 2 +- RELEASE.md | 5 ++--- soulseek-rs-lib/README.md | 7 +++---- website/src/pages/install.tsx | 9 +-------- 4 files changed, 7 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c2daa6a..db9eb9d 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ cargo install soulseek-rs # or from crates.io From source, `cargo build --release` leaves the binary at `target/release/soulseek-rs`. To build your own client on the protocol library, -add `soulseek-rs-lib = "8"` to your `Cargo.toml`. +run `cargo add soulseek-rs-lib`. ## Usage diff --git a/RELEASE.md b/RELEASE.md index 86f9777..b6356d0 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -104,7 +104,6 @@ verify it against the adjacent `.sha256`, and extract the binary. ## Using the library -```toml -[dependencies] -soulseek-rs-lib = "6" +```bash +cargo add soulseek-rs-lib ``` diff --git a/soulseek-rs-lib/README.md b/soulseek-rs-lib/README.md index 33a7756..6b41dc1 100644 --- a/soulseek-rs-lib/README.md +++ b/soulseek-rs-lib/README.md @@ -11,11 +11,10 @@ network. It can be used to build custom Soulseek clients. ## Usage -Add this to your `Cargo.toml`: +Add it to your `Cargo.toml`: -```toml -[dependencies] -soulseek-rs-lib = "8" +```bash +cargo add soulseek-rs-lib ``` ## Example diff --git a/website/src/pages/install.tsx b/website/src/pages/install.tsx index e14f800..f17cf70 100644 --- a/website/src/pages/install.tsx +++ b/website/src/pages/install.tsx @@ -357,14 +357,7 @@ const Steps = () => ( Write your own client on soulseek-rs-lib: the protocol implementation, separate from the TUI.

- +

Full API reference on docs.rs. The lib API