Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 6.41 KB

README.md

File metadata and controls

101 lines (72 loc) · 6.41 KB
Raw

RSSBud

中文文档

RSSBud can help you quickly discover and subscribe to RSS feeds from websites or apps, especially those provided by RSSHub. It supports the parameters feature of RSSHub which facilitates extra functionalities such as filtering by feed content and full text fetching.

Telegram Group

Demo.mp4

Download

Download on the App Store

Features

  • Detects RSS feeds in web pages
  • Detects RSSHub feeds applicable for web pages (supports almost all rules of RSSHub Radar)
  • Detects other RSS feeds applicable for web pages (powered by RSSBud Rules)
  • Optimized for mobile environment (automatically expands URLs and adapts to common mobile sub-domains)
  • Share sheet extension
  • Quick subscription to Reeder, Fiery Feeds, Ego Reader, and system default RSS reader
  • Quick subscription to Tiny Tiny RSS, Miniflux, Fresh RSS, Feedly, Inoreader, Feedbin, The Old Reader, Feeds Pub
  • Parameter editor for RSSHub feeds
  • Rules kept up-to-date automatically
  • Customizable remote rules files
  • Simultaneously matches against multiple rules files
  • RSSHub access control (automatically generates MD5 access code)
  • Supports x-callback-url; can be used in "Shortcuts" app to facilitate a variety of powerful functions (see Shortcut Workshop and Scheme)

Shortcut Workshop

If RSSBud doesn't support your RSS reader/service, or you want to integrate RSSBud into your workflow, you can write shortcuts utilizing RSSBud's support for x-callback-url to fulfill your needs. Let's start with the following ones!

RSSBud Starter Shortcut by cayZ | A template for RSSBud related shortcuts that sets up the variables and supports share sheets.

Analyze with RSSBud and Send with Telegram by cayZ | Send RSSBud analysis results to Telegram with customizable message template and recipient.

Analyze with RSSBud and Subscribe with Pocket Casts by cayZ | Send RSSBud analysis results to Pocket Casts (podcast RSS only).

Scan QR and Analyze with RSSBud by cayZ | Get URL from scanned QR code and analyze with RSSBud.

If you think you've got an idea of a shortcut that can benefit a larger audience, you're welcomed to submit an issue!

X-callback-url Scheme

RSSBud has implemented the x-callback-url protocol, which provides a standardized means for iOS developers to expose and document the methods they make available to other apps via custom URL schemes.

You can open the following URL to let RSSBud analyze the provided URL and return the RSS feed chosen by the user:

rssbud://x-callback-url/analyze?url[&x-callback-parameters...]

Parameters

  • url The URL you want RSSBud to analyze

x-success

  • feed_title The name of the RSS feed chosen by the user
  • feed_url The URL of the RSS feed chosen by the user

PopClip Extension

If you happen use both RSSBud and PopClip on macOS, here's a handy extension that can be used to analyze selected URLs with RSSBud. Simply select everything in the code block below and you will see an option to install the extension in PopClip.

#popclip
name: RSSBud
icon: iconify:ph:rss-bold
url: rssbud:///analyze?url=***

Notes for Building from Source

The core functionality of RSSBud comes from RSSBud Core, a sub-project written in JavaScript. The code is mainly referenced from RSSHub Radar.

Make sure you have Node.js installed before you build with Xcode.

If you wish to use the action extension, please set up your own App Group in both the iOS and Action Extension targets and modify RSSBud.appGroupIdentifier accordingly.

Rules

RSSBud’s functionality is largely powered by rules from two open-source projects. Please consider contributing to the appropriate rules if a particular feed can’t be discovered by RSSBud.

  • RSSHub Radar Rules are created and maintained by the RSSHub community. They are used to discover RSSHub feeds.

    Submit new RSSHub Radar rules

  • RSSBud Rules are a superset of RSSHub Radar rules. The extended schema allows non-RSSHub feeds (e.g. official RSS feeds that are not discoverable by parsing HTML) to be discovered. Please consider contributing to RSSHub Radar rules first if the feed is an RSSHub feed.

    Submit new RSSBud rules

Similar projects

Author

RSSBud is made by cayZ and is open-source under the MIT License.