Skip to content

Commit 47b6e98

Browse files
robbeverhelstEcho
andauthored
docs: improve README SEO for search discoverability (#113)
* docs: improve README SEO for Radarr/Sonarr CLI discoverability - Add descriptive opening paragraph targeting search terms - Add 'Why Tsarr?' section for differentiation - Add alternatives comparison table - Add keyword footer for search indexing - Updated repo description and topics separately * docs: address review feedback - remove Python comparison, trim keyword footer * docs: remove unnecessary Python mention from Why Tsarr section * docs: restore keyword footer in cleaner format --------- Co-authored-by: Echo <echo@robbeverhelst.be>
1 parent b425750 commit 47b6e98

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,17 @@
88
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
99
[![CI](https://github.com/robbeverhelst/Tsarr/workflows/CI/badge.svg)](https://github.com/robbeverhelst/Tsarr/actions)
1010

11-
**Type-safe TypeScript SDK and CLI for Servarr APIs (Radarr, Sonarr, etc.)**
11+
**A Radarr CLI, Sonarr CLI, and type-safe TypeScript SDK for the entire Servarr ecosystem.**
1212

13-
Tsarr provides type-safe TypeScript clients and a CLI for all Servarr APIs, generated from their Swagger/OpenAPI specifications. Use it as an SDK in your code or as a standalone CLI tool.
13+
Tsarr is a unified command-line tool and TypeScript SDK for managing Radarr, Sonarr, Lidarr, Readarr, Prowlarr, and Bazarr. Auto-generated from official OpenAPI specs, it gives you type-safe API clients and a powerful CLI to manage your entire *arr media stack from the terminal — no Python required.
14+
15+
## Why Tsarr?
16+
17+
- **The only type-safe TypeScript client** for all Servarr apps in one package
18+
- **Always up-to-date** — generated from official Swagger/OpenAPI specs, not manually maintained
19+
- **CLI + SDK** — use it as a standalone Radarr/Sonarr CLI tool or import it as a library in your code
20+
- **Zero dependencies for binaries** — standalone binaries for every platform, or run via Node.js/Bun
21+
- **Built for automation** — JSON output, scripting-friendly, perfect for cron jobs and CI/CD pipelines
1422

1523
## Features
1624

@@ -246,6 +254,19 @@ Perfect for building:
246254
- **Integration scripts** - Connect Servarr apps with other services and workflows
247255
- **CLI usage** - Manage your media servers directly from the terminal
248256

257+
## Alternatives
258+
259+
Looking for a Radarr CLI or Sonarr API client? Here's how Tsarr compares:
260+
261+
| Feature | Tsarr | Manual API calls |
262+
|---------|-------|-----------------|
263+
| Type safety | ✅ Full TypeScript types | ❌ None |
264+
| All *arr apps | ✅ 6 apps in one package | ⚠️ DIY per app |
265+
| CLI included | ✅ Built-in | ❌ No |
266+
| Auto-generated | ✅ From official specs | ❌ Manual |
267+
| Runtime | Node.js / Bun / standalone | curl |
268+
| Package managers | npm, Homebrew, Docker, AUR, Nix, Scoop | N/A |
269+
249270
## Contributing
250271

251272
This project uses:
@@ -257,3 +278,7 @@ This project uses:
257278
## License
258279

259280
MIT - see [LICENSE](LICENSE) file for details.
281+
282+
---
283+
284+
<sub>**Search terms:** radarr cli · sonarr cli · lidarr cli · readarr cli · prowlarr cli · bazarr cli · servarr api client · arr typescript · selfhosted media automation</sub>

0 commit comments

Comments
 (0)