chore: update changelog, readme and version

This commit is contained in:
relikd
2025-06-24 16:18:14 +02:00
parent 82e9365272
commit b846319335
3 changed files with 49 additions and 25 deletions

View File

@@ -8,6 +8,20 @@ and this project does adhere to [Semantic Versioning](https://semver.org/spec/v2
## [Unreleased] ## [Unreleased]
## [1.3.0] 2025-06-24
### Added
- *Adding feed:* Regex Converter for websites without RSS feed (hold down option key during edit)
### Fixed
- *Adding feed:* Keep aspect ratio of favicon inside button (related to fix in v1.2.3)
## [1.2.3] 2025-06-09
### Fixed
- *Adding feed:* Favicon size inside button
- *DB:* Feeds with changing urls -> use guid for unique check
## [1.2.2] 2023-06-18 ## [1.2.2] 2023-06-18
### Fixed ### Fixed
- Feed menu sporadically not opening - Feed menu sporadically not opening
@@ -25,7 +39,7 @@ and this project does adhere to [Semantic Versioning](https://semver.org/spec/v2
## [1.2.0] 2022-10-01 ## [1.2.0] 2022-10-01
### Added ### Added
- *UI*: Add option to hide read articles (show only unread) - *UI:* Add option to hide read articles (show only unread)
## [1.1.3] 2020-12-18 ## [1.1.3] 2020-12-18
@@ -46,8 +60,8 @@ and this project does adhere to [Semantic Versioning](https://semver.org/spec/v2
## [1.1.0] 2020-01-17 ## [1.1.0] 2020-01-17
### Added ### Added
- *QuickLook*: Thumbnail previews for OPML files (QLOPML v1.3) - *QuickLook:* Thumbnail previews for OPML files (QLOPML v1.3)
- *Status Bar Menu*: Tint menu bar icon with Accent color (macOS 10.14+) - *Status Bar Menu:* Tint menu bar icon with Accent color (macOS 10.14+)
### Fixed ### Fixed
- Resolved Xcode warnings in Xcode 11 - Resolved Xcode warnings in Xcode 11
@@ -55,9 +69,9 @@ and this project does adhere to [Semantic Versioning](https://semver.org/spec/v2
## [1.0.2] 2019-10-25 ## [1.0.2] 2019-10-25
### Fixed ### Fixed
- *Status Bar Menu*: Preferences could not be opened on macOS 10.15 - *Status Bar Menu:* Preferences could not be opened on macOS 10.15
- *Status Bar Menu*: Menu flickering resulting in a hang on macOS 10.15 - *Status Bar Menu:* Menu flickering resulting in a hang on macOS 10.15
- *UI*: Text color in `About` tab - *UI:* Text color in `About` tab
## [1.0.1] 2019-10-04 ## [1.0.1] 2019-10-04
@@ -100,7 +114,7 @@ and this project does adhere to [Semantic Versioning](https://semver.org/spec/v2
- *Settings, Feeds:* Status info with accurate download count (instead of `Updating feeds …`) - *Settings, Feeds:* Status info with accurate download count (instead of `Updating feeds …`)
- *Settings, Feeds:* Status info shows `No network connection` and `Updates paused` - *Settings, Feeds:* Status info shows `No network connection` and `Updates paused`
- *Settings, Feeds:* After feed edit, run update scheduler immediately - *Settings, Feeds:* After feed edit, run update scheduler immediately
- *Status Bar Menu*: Feed title is updated properly - *Status Bar Menu:* Feed title is updated properly
- *UI:* If an error occurs, show document URL (path to file or web url) - *UI:* If an error occurs, show document URL (path to file or web url)
- Comparison of existing articles with nonexistent guid and link - Comparison of existing articles with nonexistent guid and link
- Don't mark articles read if opening URLs failed - Don't mark articles read if opening URLs failed
@@ -112,12 +126,12 @@ and this project does adhere to [Semantic Versioning](https://semver.org/spec/v2
- *Adding feed:* Refresh interval hotkeys set to: `⌘1``⌘6` - *Adding feed:* Refresh interval hotkeys set to: `⌘1``⌘6`
- *Settings, Feeds:* Single add button for feeds, groups, and separators - *Settings, Feeds:* Single add button for feeds, groups, and separators
- *Settings, Feeds:* Always append new items at the end - *Settings, Feeds:* Always append new items at the end
- *Settings, General*: Moved `Fix cache` button to `About` text section - *Settings, General:* Moved `Fix cache` button to `About` text section
- *Settings, General*: Changing default feed reader is prohibited within sandbox - *Settings, General:* Changing default feed reader is prohibited within sandbox
- *Settings, General*: [Auxiliary application](https://github.com/relikd/URL-Scheme-Defaults) for changing default feed reader - *Settings, General:* [Auxiliary application](https://github.com/relikd/URL-Scheme-Defaults) for changing default feed reader
- *Status Bar Menu*: Show `(no title)` instead of `(error)` - *Status Bar Menu:* Show `(no title)` instead of `(error)`
- *Status Bar Menu*: `Update all feeds` will show error alert for broken URLs - *Status Bar Menu:* `Update all feeds` will show error alert for broken URLs
- *DB*: Dropping table `FeedIcon` in favor of image files cache - *DB:* Dropping table `FeedIcon` in favor of image files cache
- *UI:* Interface builder files replaced with code equivalent - *UI:* Interface builder files replaced with code equivalent
- *UI:* Mark unread articles with blue dot, instead of tick mark - *UI:* Mark unread articles with blue dot, instead of tick mark
@@ -173,7 +187,9 @@ and this project does adhere to [Semantic Versioning](https://semver.org/spec/v2
Initial release Initial release
[Unreleased]: https://github.com/relikd/baRSS/compare/v1.2.2...HEAD [Unreleased]: https://github.com/relikd/baRSS/compare/v1.3.0...HEAD
[1.3.0]: https://github.com/relikd/baRSS/compare/v1.2.3...v1.3.0
[1.2.3]: https://github.com/relikd/baRSS/compare/v1.2.2...v1.2.3
[1.2.2]: https://github.com/relikd/baRSS/compare/v1.2.1...v1.2.2 [1.2.2]: https://github.com/relikd/baRSS/compare/v1.2.1...v1.2.2
[1.2.1]: https://github.com/relikd/baRSS/compare/v1.2.0...v1.2.1 [1.2.1]: https://github.com/relikd/baRSS/compare/v1.2.0...v1.2.1
[1.2.0]: https://github.com/relikd/baRSS/compare/v1.1.3...v1.2.0 [1.2.0]: https://github.com/relikd/baRSS/compare/v1.1.3...v1.2.0

View File

@@ -72,6 +72,16 @@ However, you can still add the application to auto boot by adding it to the syst
`System Preferences > User > Login Items` `System Preferences > User > Login Items`
### UI options
1. If you hold down the option key and click on an article item, you can mark a single item (un-)read without opening it.
2. To add websites without RSS feed you can use the regex converter.
Hold down the option key in the feed edit modal and click the red regex button.
Though, admittedly, this is for experts only.
I still have to find a nice user-friendly way to achieve this.
### CLI options ### CLI options
The following options have no UI equivalent and must be configured in Terminal. The following options have no UI equivalent and must be configured in Terminal.
@@ -79,35 +89,33 @@ Most likely, you will never stumble upon these if not reading this chapter.
**Note:** To reset an option run `defaults delete de.relikd.baRSS {KEY}`, where `{KEY}` is an option from below. **Note:** To reset an option run `defaults delete de.relikd.baRSS {KEY}`, where `{KEY}` is an option from below.
1. If you hold down the option key and click on an article item, you can mark a single item (un-)read without opening it. 1. When holding down the option key, the menu will show an item to open only a few unread items at a time.
2. When holding down the option key, the menu will show an item to open only a few unread items at a time.
This number can be changed with the following Terminal command (default: 10): This number can be changed with the following Terminal command (default: 10):
``` ```
defaults write de.relikd.baRSS openFewLinksLimit -int 10 defaults write de.relikd.baRSS openFewLinksLimit -int 10
``` ```
3. In preferences you can choose to show 'Short article names'. 2. In preferences you can choose to show 'Short article names'.
This will limit the number of displayed characters to 60 (default). This will limit the number of displayed characters to 60 (default).
With this Terminal command you can customize this limit: With this Terminal command you can customize this limit:
``` ```
defaults write de.relikd.baRSS shortArticleNamesLimit -int 50 defaults write de.relikd.baRSS shortArticleNamesLimit -int 50
``` ```
4. Limit the number of displayed articles per feed menu. 3. Limit the number of displayed articles per feed menu.
**Note:** displayed unread count may be different than the unread items inside. 'Open all unread' will open hidden items too. **Note:** displayed unread count may be different than the unread items inside. 'Open all unread' will open hidden items too.
``` ```
defaults write de.relikd.baRSS articlesInMenuLimit -int 40 defaults write de.relikd.baRSS articlesInMenuLimit -int 40
``` ```
5. You can change the appearance of colors throughout the application. 4. You can change the appearance of colors throughout the application.
E.g., The tint color of the menu bar icon and the color of the blue unread articles dot. E.g., The tint color of the menu bar icon and the color of the blue unread articles dot.
``` ```
defaults write de.relikd.baRSS colorStatusIconTint -string "#37F" defaults write de.relikd.baRSS colorStatusIconTint -string "#37F"
defaults write de.relikd.baRSS colorUnreadIndicator -string "#FBA33A" defaults write de.relikd.baRSS colorUnreadIndicator -string "#FBA33A"
``` ```
6. To backup your list of subscribed feeds, here is a one-liner: 5. To backup your list of subscribed feeds, here is a one-liner:
``` ```
open barss:backup && cp "$HOME/Library/Containers/de.relikd.baRSS/Data/Library/Application Support/baRSS/backup/feeds_latest.opml" "$HOME/Desktop/baRSS_backup_$(date "+%Y-%m-%d").opml" open barss:backup && cp "$HOME/Library/Containers/de.relikd.baRSS/Data/Library/Application Support/baRSS/backup/feeds_latest.opml" "$HOME/Desktop/baRSS_backup_$(date "+%Y-%m-%d").opml"
``` ```
@@ -120,7 +128,7 @@ ToDo
The following list is a collection of ideas that may be added if people request it. The following list is a collection of ideas that may be added if people request it.
- [ ] Localizations - [ ] Localizations
- [ ] Feed generator for websites without feeds - [x] Feed generator for websites without feeds
- [ ] Automatically choose best update interval (e.g., avg) - [ ] Automatically choose best update interval (e.g., avg)
- [ ] Sync with online services - [ ] Sync with online services
- [ ] Feeds with authentication - [ ] Feeds with authentication
@@ -183,7 +191,7 @@ This project uses a modified version of Brent Simmons' [RSXML] for feed parsing.
##### Trivia ##### Trivia
- Start of project: __July 19, 2018__ - Start of project: __July 19, 2018__
- Estimated development time: __1970h+__ - Estimated development time: __2020h+__
- First prototype used __feedparser python__ library - First prototype used __feedparser python__ library

View File

@@ -45,7 +45,7 @@
<key>CFBundlePackageType</key> <key>CFBundlePackageType</key>
<string>APPL</string> <string>APPL</string>
<key>CFBundleShortVersionString</key> <key>CFBundleShortVersionString</key>
<string>1.2.3</string> <string>1.3.0</string>
<key>CFBundleURLTypes</key> <key>CFBundleURLTypes</key>
<array> <array>
<dict> <dict>
@@ -70,7 +70,7 @@
</dict> </dict>
</array> </array>
<key>CFBundleVersion</key> <key>CFBundleVersion</key>
<string>15069</string> <string>15681</string>
<key>LSApplicationCategoryType</key> <key>LSApplicationCategoryType</key>
<string>public.app-category.news</string> <string>public.app-category.news</string>
<key>LSMinimumSystemVersion</key> <key>LSMinimumSystemVersion</key>