Initial commit
This commit is contained in:
36
readme.md
Normal file
36
readme.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# shanty-watch
|
||||
|
||||
Library watchlist management for [Shanty](ssh://connor@git.rcjohnstone.com:2222/Shanty/shanty.git).
|
||||
|
||||
Tracks what music the user *wants* vs what they *have*. Supports monitoring at
|
||||
artist, album, and individual track level. Auto-detects owned items by fuzzy-matching
|
||||
against the indexed library.
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
# Add items to the watchlist
|
||||
shanty-watch add artist "Pink Floyd"
|
||||
shanty-watch add album "Pink Floyd" "The Dark Side of the Moon"
|
||||
shanty-watch add track "Pink Floyd" "Time"
|
||||
|
||||
# List watchlist items
|
||||
shanty-watch list
|
||||
shanty-watch list --status wanted
|
||||
shanty-watch list --artist "Pink Floyd"
|
||||
|
||||
# Library summary
|
||||
shanty-watch status
|
||||
|
||||
# Remove an item
|
||||
shanty-watch remove 42
|
||||
```
|
||||
|
||||
## Status Flow
|
||||
|
||||
`Wanted` → `Available` → `Downloaded` → `Owned`
|
||||
|
||||
- **Wanted**: User wants this but doesn't have it
|
||||
- **Available**: Found online but not yet downloaded
|
||||
- **Downloaded**: Downloaded but not yet processed
|
||||
- **Owned**: Fully processed, tagged, and organized in the library
|
||||
Reference in New Issue
Block a user