feat(yarr): Added download option
This commit is contained in:
44
README.md
44
README.md
@@ -17,6 +17,7 @@ This workspace contains two crates:
|
||||
- Browse series and episodes
|
||||
- Monitor download queue
|
||||
- View download history
|
||||
- **Search for new series and download releases** - Interactive search with release selection and download
|
||||
- Interactive TUI interface with vim-like keybind support
|
||||
- Configurable UI preferences and keybind modes
|
||||
- In-app configuration editing for Sonarr connection and UI settings
|
||||
@@ -98,6 +99,25 @@ yarr
|
||||
yarr tui
|
||||
```
|
||||
|
||||
#### Search and Download Functionality
|
||||
|
||||
The Search tab provides powerful functionality for finding and downloading new series:
|
||||
|
||||
1. **Search for Series**: Press `/` to enter search mode, type a series name, and press Enter
|
||||
2. **View Releases**: Navigate to a search result and press Enter to view available releases
|
||||
3. **Download**: In the releases popup, select a release and press Enter to download it
|
||||
|
||||
**Release Information Display**:
|
||||
- Status indicators: ✅ Available, ❌ Rejected, ⛔ Not Allowed
|
||||
- File size, quality rating, indexer name
|
||||
- Seeders/peers count for torrent releases
|
||||
- Full release title for identification
|
||||
|
||||
**Download Selection**:
|
||||
- Only releases marked as "Available" can be downloaded
|
||||
- Choose based on quality, file size, and seed count
|
||||
- Downloads are sent to your configured download client
|
||||
|
||||
### Command Line Mode
|
||||
|
||||
List all series:
|
||||
@@ -180,11 +200,12 @@ yarr completions powershell > yarr.ps1
|
||||
|
||||
- `q` - Quit
|
||||
- `↑/↓` or `j/k` - Navigate up/down
|
||||
- `Enter` - Select/expand
|
||||
- `Enter` - Select/expand item or show releases (in Search tab)
|
||||
- `Tab` - Switch between tabs
|
||||
- `d` - Toggle details
|
||||
- `r` - Refresh data
|
||||
- `/` - Search (in Search tab)
|
||||
- `Esc` - Close popups or cancel search
|
||||
- `s` - Save configuration changes
|
||||
|
||||
### Vim Mode
|
||||
@@ -198,6 +219,8 @@ yarr completions powershell > yarr.ps1
|
||||
- `u` - Refresh data (undo)
|
||||
- `/` - Search mode
|
||||
- `i` - Insert/input mode
|
||||
- `Enter` - Select/expand item or show releases (in Search tab)
|
||||
- `Esc` - Close popups or cancel operations
|
||||
- `s` - Save configuration changes
|
||||
|
||||
### Settings Tab
|
||||
@@ -210,6 +233,23 @@ Use the Settings tab to:
|
||||
|
||||
Access the Settings tab by navigating to the last tab or pressing `Tab` repeatedly.
|
||||
|
||||
### Search Tab Usage
|
||||
|
||||
The Search tab provides comprehensive series search and download functionality:
|
||||
|
||||
1. **Enter Search Mode**: Press `/` to start typing a search query
|
||||
2. **Search**: Type the series name and press Enter to search
|
||||
3. **Browse Results**: Use ↑/↓ or j/k to navigate through search results
|
||||
4. **View Releases**: Press Enter on a search result to open the releases popup
|
||||
5. **Download**: In the releases popup, select a release and press Enter to download
|
||||
6. **Close Popup**: Press Esc to close the releases popup
|
||||
|
||||
**Release Popup Features**:
|
||||
- Shows all available releases for the selected series
|
||||
- Displays quality, size, indexer, and availability status
|
||||
- Color-coded status indicators for easy identification
|
||||
- Download progress feedback through status messages
|
||||
|
||||
### In-App Configuration
|
||||
|
||||
You can configure Sonarr connection settings directly within the application:
|
||||
@@ -261,7 +301,7 @@ async fn main() -> Result<()> {
|
||||
}
|
||||
```
|
||||
|
||||
See the [yarr-api README](yarr-api/README.md) for detailed API documentation and examples.
|
||||
See the [yarr-api README](yarr-api/README.md) for detailed API documentation and examples, including the new download after search functionality.
|
||||
|
||||
## Development
|
||||
|
||||
|
||||
Reference in New Issue
Block a user