From 2796402fffe2b54eae9a8593b04988c247d21b9c Mon Sep 17 00:00:00 2001 From: Jeff Hughes Date: Tue, 1 Dec 2020 18:19:42 -0500 Subject: [PATCH] Bump to v1.1.0 and update readme --- CHANGELOG.md | 19 +++++++++++++++++++ Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 11 +++++++++++ 4 files changed, 32 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 826c7cb..b4cd3c3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,23 @@ # Changelog +## v1.1.0 (2020-12-01) +- Help menu showing the current keybindings (accessible by pressing + "?" by default) +- New options for downloading new episodes: + - Can select whether to always download new episodes when syncing + podcasts, to never download, or to pop up with a window allowing + you to select which new episodes to download +- Will now ask for confirmation before removing podcasts/episodes + (thanks to contributor [dougli1sqrd](https://github.com/dougli1sqrd)) +- Bug fixes: + - Border gets redrawn properly when scrolling (thanks to contributor [a-kenji](https://github.com/a-kenji)) + - Messages at the bottom of the screen properly reset cursor + position, so they always show up on the far left +- Other notes: + - Added consistent code formatting style with rustfmt (thanks to + contributor [thunderbiscuit](https://github.com/thunderbiscuit)) + + ## v1.0.1 (2020-08-18) - This is a patch release to fix some minor bugs - Bug fixes: @@ -7,6 +25,7 @@ - Fix decoding of HTML entities in episode descriptions to avoid getting cut off in certain cases - Properly import OPML v1.0 files - Correctly segment titles with Unicode letters + - Also some fixes to documentation (thanks to contributor [dwvisser](https://github.com/dwvisser)) ## v1.0.0 (2020-08-13) - Adjusted the criteria for checking existing episodes when syncing, which results in a dramatic speedup in the syncing process diff --git a/Cargo.lock b/Cargo.lock index 29d4947..ba19742 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -863,7 +863,7 @@ dependencies = [ [[package]] name = "shellcaster" -version = "1.0.1" +version = "1.1.0" dependencies = [ "chrono", "clap", diff --git a/Cargo.toml b/Cargo.toml index f920705..c55bf62 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "shellcaster" -version = "1.0.1" +version = "1.1.0" authors = ["Jeff Hughes "] edition = "2018" license = "GPL-3.0-or-later" diff --git a/README.md b/README.md index 9a358e0..843c1c1 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,14 @@ The sample file above provides comments that should walk you through all the ava * Command used to play episodes. Use "%s" to indicate where file/URL will be entered to the command. Note that shellcaster does *not* include a native media player -- it simply passes the file path/URL to the given command with no further checking as to its success or failure. This process is started *in the background*, so be sure to send it to a program that has GUI controls of some kind so you have control over the playback. * Default: "vlc %s" +**download_new_episodes**: +* Configures what happens when new episodes are found as podcasts are synced. Valid options: + * "always" will automatically download all new episodes; + * "ask-selected" will open a popup window to let you select which episodes to download, with all of them selected by default; + * "ask-unselected" will open a popup window to let you select with episodes to download, with none of them selected by default; + * "never" will never automatically download new episodes. +* Default: "ask-unselected" + **simultaneous_downloads**: * Maximum number of files to download simultaneously. Setting this too high could result in network requests being denied. A good general guide would be to set this to the number of processor cores on your computer. * Default: 3 @@ -167,6 +175,7 @@ The sample file above provides comments that should walk you through all the ava | Key | Action | | ------- | -------------- | +| ? | Open help window | | Arrow keys / h,j,k,l | Navigate menus | | a | Add new feed | | q | Quit program | @@ -192,6 +201,8 @@ Some users may wish to sync their podcasts automatically on a regular basis, e.g Contributions from others are welcome! If you wish to contribute, feel free to clone the repo and submit pull requests. **Please ensure you are on the `develop` branch when making your edits**, as this is where the continued development of the app is taking place. Pull requests will only be merged to the `develop` branch, so you can help to avoid merge conflicts by doing your work on that branch in the first place. +Thanks to these fine folks who have made contributions: [a-kenji](https://github.com/a-kenji), [dougli1sqrd](https://github.com/dougli1sqrd), [dwvisser](https://github.com/dwvisser), [thunderbiscuit](https://github.com/thunderbiscuit) + ## Why "shellcaster"? I was trying to come up with a play on the word "podcast", and I liked the use of the word "shell" for several reasons. "Shell" is a synonym for the word "pod". The terminal is also referred to as a shell (and shellcaster is a terminal-based program). In addition, the program is built on Rust, whose mascot is Ferris the crab. Finally, I just personally enjoy that "shellcaster" sounds a lot like "spellcaster", so you can feel like a wizard when you use the program... \ No newline at end of file