mirror of
https://github.com/LukeHagar/Prowlarr-TS-SDK.git
synced 2025-12-06 04:21:03 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.596.0
This commit is contained in:
31
examples/README.md
Normal file
31
examples/README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# prowlarr Examples
|
||||
|
||||
This directory contains example scripts demonstrating how to use the prowlarr SDK.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js (v18 or higher)
|
||||
- npm
|
||||
|
||||
## Setup
|
||||
|
||||
1. Copy `.env.template` to `.env`:
|
||||
```bash
|
||||
cp .env.template .env
|
||||
```
|
||||
|
||||
2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
|
||||
|
||||
## Running the Examples
|
||||
|
||||
To run an example file from the examples directory:
|
||||
|
||||
```bash
|
||||
npm run build && npx tsx example.ts
|
||||
```
|
||||
|
||||
## Creating new examples
|
||||
|
||||
Duplicate an existing example file, they won't be overwritten by the generation process.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user