docs: open the README with the logo and the site's own intro

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.
This commit is contained in:
Michel de Graaf
2026-07-25 02:55:47 +02:00
parent 692e8008e0
commit 13c58feafe
3 changed files with 86 additions and 3 deletions
+17 -3
View File
@@ -1,8 +1,22 @@
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="fixtures/logo-ink.svg">
<img src="fixtures/logo-light.svg" alt="soulseek-rs" width="132">
</picture>
</div>
# 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.