diff options
| author | Nathan Jaremko | 2017-12-05 15:28:40 -0500 |
|---|---|---|
| committer | Nathan Jaremko | 2017-12-05 15:28:40 -0500 |
| commit | e5908c89870884c4d50ab31124f1c55523eff9a4 (patch) | |
| tree | c684dabe08bef0f9a115ae3acb811847b3be3b72 | |
| parent | 978dbf71f22e3123b2f25154cfbe20a6e207dfe3 (diff) | |
| download | podcast-e5908c89870884c4d50ab31124f1c55523eff9a4.tar.bz2 | |
Add README.md again
| -rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1161056 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ + # podcast + --- + `podcast` is a command line podcast player. + + NOTE: Playback requires either mpv or vlc to be installed + + It currently supports: +- [x] Subscribing to RSS feeds +- [x] Unsubscribing from RSS feeds +- [x] Streaming podcasts +- [x] Parallel downloading of multiple podcasts +- [x] Playing podcasts +- [x] Auto-download new episodes +- [x] Automatically check for updates +- [ ] Auto-delete old episodes +- [ ] Shell Completions + - [x] zsh + - [ ] bash + - [ ] sh +- [ ] Searching for podcasts...(WIP) + +By default, podcasts are downloaded to $HOME/Podcasts, but this folder can be set with the $PODCASTS environmental variable. + +How many latest episodes to download when subscibing to new podcasts can be set in the $PODCASTS/.config YAML file + +Downloads can be done a variety of ways: + +Individually: `podcast download $podcast_name 4` + +Multiple: `podcast download $podcast_name 1,5,9-12,14` + +All: `podcast download $podcast_name` |