docs: stop pinning a library version the instructions cannot keep current

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.
This commit is contained in:
Michel de Graaf
2026-09-10 12:08:00 +02:00
parent 5581fa6d10
commit 1b898adeeb
4 changed files with 7 additions and 16 deletions
+1 -1
View File
@@ -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
+2 -3
View File
@@ -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
```
+3 -4
View File
@@ -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
+1 -8
View File
@@ -357,14 +357,7 @@ const Steps = () => (
Write your own client on <Code>soulseek-rs-lib</Code>: the protocol
implementation, separate from the TUI.
</p>
<Terminal
label="Cargo.toml"
lines={[
{ t: 'cm', text: '[dependencies]' },
{ t: 'code', text: 'soulseek-rs-lib = "8"' },
]}
copy={'[dependencies]\nsoulseek-rs-lib = "8"'}
/>
<Terminal lines={[{ t: 'cmd', text: 'cargo add soulseek-rs-lib' }]} />
<Terminal label="src/main.rs" lines={LIB_LINES} copy={LIB_SRC} />
<p className="text-[13px] text-muted">
Full API reference on <ExtLink href={LINKS.docsrs}>docs.rs</ExtLink>. The lib API