From 13c58feafebde47f3c5f450248e8c6ba2c18efc5 Mon Sep 17 00:00:00 2001 From: Michel de Graaf Date: Sat, 25 Jul 2026 02:55:47 +0200 Subject: [PATCH] docs: open the README with the logo and the site's own intro MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The logo ships in both variants the site uses, picked by prefers-color-scheme so it stays legible on either GitHub theme — the names are inverted from what you would guess, `ink` being the cream one for dark backgrounds. The opening copy now matches the site rather than describing the project twice in two voices, and still says the repository holds a library as well as a client. --- README.md | 20 +++++++++++++++++--- fixtures/logo-ink.svg | 37 +++++++++++++++++++++++++++++++++++++ fixtures/logo-light.svg | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 86 insertions(+), 3 deletions(-) create mode 100644 fixtures/logo-ink.svg create mode 100644 fixtures/logo-light.svg diff --git a/README.md b/README.md index 584d4f4..ccb4a64 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,22 @@ +
+ + + soulseek-rs + +
+ # Soulseek-rs 🦀 -Soulseek-rs is a Soulseek library and client built in Rust. Soulseek is a -closed-source P2P file-sharing network from the 2000s. It's still used by -music enthusiasts around the world to share niche music. +**A soulseek client for the terminal. Built for agents and people who live +there.** + +Search the network, share your files, browse someone's collection, join a room. +It runs over ssh on the machine where your music already lives. + +Soulseek is a closed-source P2P file-sharing network from the 2000s, still used +by music enthusiasts around the world to share niche music. This repository is +that client plus [`soulseek-rs-lib`](./soulseek-rs-lib), the protocol library it +is built on. **[re-invention.nl/soulseek-rs](https://re-invention.nl/soulseek-rs/)** — what it does, how to install it, and every `config.toml` setting. diff --git a/fixtures/logo-ink.svg b/fixtures/logo-ink.svg new file mode 100644 index 0000000..620acb1 --- /dev/null +++ b/fixtures/logo-ink.svg @@ -0,0 +1,37 @@ + + + \ No newline at end of file diff --git a/fixtures/logo-light.svg b/fixtures/logo-light.svg new file mode 100644 index 0000000..ee37762 --- /dev/null +++ b/fixtures/logo-light.svg @@ -0,0 +1,32 @@ + + + \ No newline at end of file