feat(lib): reserve client minor versions 1 (unidentified) and 2 (reference client)

Document the minor-version registry on ClientVersion: within the soulseek-rs major (176), minor 1 stays the library default for unidentified consumers and minor 2 is now the reference CLI/TUI client. Downstream clients reserve their own minor via issue #12.
2026-08-17 09:46:06 +02:00
parent 1833717521
commit ac06cb9a5a
2 changed files with 18 additions and 5 deletions
@@ -171,8 +171,9 @@ pub struct ClientSettings {
    /// Empty means nothing is shared.
    pub shared_directories: Vec<String>,
    /// The version reported to the server on login. Defaults to the
-    /// soulseek-rs major version with minor version 1; clients and bots built
-    /// on this library should pick their own minor version.
+    /// soulseek-rs major version with minor version 1 ("unidentified");
+    /// clients and bots built on this library should reserve their own minor
+    /// version (see [`ClientVersion`]).
    pub version: ClientVersion,
 }