docs: list projects built on soulseek-rs-lib
Add a 'Projects using soulseek-rs-lib' section to the README and a matching section on the website community page, starting with seakarr. Both point new projects at issue #12 to reserve a client minor version.
This commit is contained in:
@@ -57,6 +57,15 @@ implementation for anyone building their own client, and **soulseek-rs**, the
|
|||||||
client built on it. The library stays lean on dependencies and has none today;
|
client built on it. The library stays lean on dependencies and has none today;
|
||||||
the client takes them freely.
|
the client takes them freely.
|
||||||
|
|
||||||
|
### Projects using soulseek-rs-lib
|
||||||
|
|
||||||
|
- [seakarr](https://github.com/binhex/seakarr) — automated Soulseek music
|
||||||
|
downloader with library quality upgrading.
|
||||||
|
|
||||||
|
Built something on the library? Open a PR to add it here, and reserve a client
|
||||||
|
minor version in [#12](https://github.com/michel/soulseek-rs/issues/12) so your
|
||||||
|
project is identifiable on the network.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Homebrew ships a prebuilt binary, so no Rust toolchain:
|
Homebrew ships a prebuilt binary, so no Rust toolchain:
|
||||||
|
|||||||
@@ -13,6 +13,8 @@ export const LINKS = {
|
|||||||
slskd: 'https://github.com/slskd/slskd',
|
slskd: 'https://github.com/slskd/slskd',
|
||||||
slsknet: 'https://www.slsknet.org',
|
slsknet: 'https://www.slsknet.org',
|
||||||
seeleseek: 'https://seeleseek.net',
|
seeleseek: 'https://seeleseek.net',
|
||||||
|
seakarr: 'https://github.com/binhex/seakarr',
|
||||||
|
minorVersions: 'https://github.com/michel/soulseek-rs/issues/12',
|
||||||
} as const
|
} as const
|
||||||
|
|
||||||
export const VERSION = __APP_VERSION__
|
export const VERSION = __APP_VERSION__
|
||||||
|
|||||||
@@ -259,6 +259,31 @@ export const Community = () => {
|
|||||||
</Cols>
|
</Cols>
|
||||||
</Section>
|
</Section>
|
||||||
|
|
||||||
|
<Section>
|
||||||
|
<SectionHead
|
||||||
|
eyebrow="built on the library"
|
||||||
|
title="Projects using soulseek-rs-lib."
|
||||||
|
>
|
||||||
|
The protocol crate is there for anyone building their own client, bot, or
|
||||||
|
automation on Soulseek. These projects do.
|
||||||
|
</SectionHead>
|
||||||
|
<Cols start>
|
||||||
|
<Prose>
|
||||||
|
<p>
|
||||||
|
<ExtLink href={LINKS.seakarr}>seakarr</ExtLink> — automated Soulseek music
|
||||||
|
downloader with library quality upgrading: it scans your collection, finds
|
||||||
|
albums below your bitrate bar, and fetches better copies.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Built something on <Code>soulseek-rs-lib</Code>? Open a pull request to get
|
||||||
|
listed, and{' '}
|
||||||
|
<ExtLink href={LINKS.minorVersions}>reserve a client minor version</ExtLink>{' '}
|
||||||
|
so your project is identifiable on the network.
|
||||||
|
</p>
|
||||||
|
</Prose>
|
||||||
|
</Cols>
|
||||||
|
</Section>
|
||||||
|
|
||||||
<Section>
|
<Section>
|
||||||
<SectionHead
|
<SectionHead
|
||||||
eyebrow="what this is not"
|
eyebrow="what this is not"
|
||||||
|
|||||||
Reference in New Issue
Block a user