tsarr 1.0.0 β 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -11
- package/dist/index.js +1 -1
- package/dist/tsarr-1.1.0.tgz +0 -0
- package/package.json +4 -1
- package/dist/tsarr-1.0.0.tgz +0 -0
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
**Type-safe TypeScript SDK for Servarr APIs (Radarr, Sonarr, etc.)**
|
|
9
9
|
|
|
10
|
-
TsArr provides type-safe TypeScript clients for all Servarr APIs, generated from their Swagger/OpenAPI specifications.
|
|
10
|
+
TsArr provides type-safe TypeScript clients for all Servarr APIs, generated from their Swagger/OpenAPI specifications. Perfect for building automation tools, scripts, and applications to manage your media servers.
|
|
11
11
|
|
|
12
12
|
## Features
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ TsArr provides type-safe TypeScript clients for all Servarr APIs, generated from
|
|
|
16
16
|
- π¦ **Modular** - Separate modules for each Servarr app (Radarr, Sonarr, etc.)
|
|
17
17
|
- π³ **Tree-shakable** - Lightweight and dependency-minimal
|
|
18
18
|
- π **Auto-generated** - CI pipeline regenerates when APIs change
|
|
19
|
-
-
|
|
19
|
+
- π€ **Automation-friendly** - Perfect for building tools and scripts
|
|
20
20
|
|
|
21
21
|
## Supported Servarr Apps
|
|
22
22
|
|
|
@@ -76,20 +76,18 @@ bun run format
|
|
|
76
76
|
|
|
77
77
|
## π Documentation
|
|
78
78
|
|
|
79
|
+
- [API Documentation](https://robbeverhelst.github.io/tsarr/) - Auto-generated TypeScript API docs
|
|
79
80
|
- [Usage Guide](./docs/usage.md) - Complete usage documentation with examples
|
|
80
81
|
- [Examples](./docs/examples.md) - Real-world automation examples
|
|
81
|
-
- [IaC Integration](./docs/iac-integration.md) - Docker, Kubernetes, Terraform guides
|
|
82
|
-
- [Releasing](./docs/releasing.md) - Release process and conventional commits
|
|
83
|
-
- [Setup Secrets](./docs/setup-secrets.md) - Configure GitHub secrets for releases
|
|
84
82
|
- [Examples Directory](./examples/) - Runnable example scripts
|
|
85
83
|
|
|
86
|
-
##
|
|
84
|
+
## Use Cases
|
|
87
85
|
|
|
88
|
-
|
|
89
|
-
- **
|
|
90
|
-
- **
|
|
91
|
-
- **
|
|
92
|
-
- **
|
|
86
|
+
Perfect for building:
|
|
87
|
+
- **Automation scripts** - Bulk movie imports, library maintenance, and media organization
|
|
88
|
+
- **Management tools** - Custom dashboards, backup utilities, and monitoring scripts
|
|
89
|
+
- **Integration scripts** - Connect Servarr apps with other services and workflows
|
|
90
|
+
- **CLI tools** - Command-line utilities for media server administration
|
|
93
91
|
|
|
94
92
|
## Contributing
|
|
95
93
|
|