Skip to content

Commit 859bc54

Browse files
committed
add readme
1 parent 55ad7fa commit 859bc54

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# ferristream
2+
3+
Stream torrents directly to your media player. Search, select, watch - no permanent storage needed.
4+
5+
## Installation
6+
7+
Download the latest binary from [Releases](https://github.com/ramon-dev/ferristream/releases), or build from source:
8+
9+
```bash
10+
cargo install --git https://github.com/ramon-dev/ferristream
11+
```
12+
13+
## Configuration
14+
15+
Create `~/.config/ferristream/config.toml`:
16+
17+
```toml
18+
[prowlarr]
19+
url = "http://localhost:9696"
20+
apikey = "your-prowlarr-api-key"
21+
22+
[player]
23+
command = "mpv"
24+
```
25+
26+
## Usage
27+
28+
```bash
29+
ferristream
30+
```
31+
32+
- Type to search, suggestions appear as you type
33+
- `Tab` to accept suggestion, `Enter` to search
34+
- ``/`` to navigate results
35+
- `Enter` to stream
36+
- `d` for connection diagnostics
37+
38+
## Requirements
39+
40+
- [Prowlarr](https://prowlarr.com/) instance with configured indexers
41+
- Media player (mpv, vlc, etc.)

0 commit comments

Comments
 (0)