Skip to content

Commit

Permalink
docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
martinrotter committed Dec 19, 2024
1 parent 55246c6 commit 8edd0f3
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ RSS Guard is a simple RSS/ATOM feed reader for Windows, Linux, BSD, OS/2 or macO

RSS Guard is also podcast player as it can play everything via its built-in `mpv`-based (or `ffmpeg`-based) media player.

Also, RSS Guard has built-in support for [Gemini](https://geminiprotocol.net) protocol and hypertext format, so it can very well act as reliable cross-platform Gemini client!

![RSS Guard](resources/graphics/official_pictures/main-window-linux.png)

## Contributing to RSS Guard
Expand Down
2 changes: 1 addition & 1 deletion docs/source/features/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Passed article also offers a special function:
Boolean MessageObject.isAlreadyInDatabase(DuplicateCheck)
```

which allows you to perform runtime check for existence of the article in RSS Guards database. Parameter is the value from enumeration `DuplicateCheck`. It specifies how exactly the article should match.
which allows you to perform runtime check for existence of the article in RSS Guard database. Parameter is the value from enumeration `DuplicateCheck`. It specifies how exactly the article should match.

For example, if you want to check if there is already another article by the same author in a database, you should call `msg.isAlreadyInDatabase(MessageObject.SameAuthor)`.
The values of enumeration can be combined in a single call with the [bitwise OR](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_OR) (`|`) operator, like this:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
RSS Guards Documentation!
RSS Guard Documentation!
=========================

.. toctree::
Expand Down
2 changes: 2 additions & 0 deletions docs/source/supported-readers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ RSS Guard is multi-account application and supports many web-based feed readers
* [JSON](https://www.jsonfeed.org)
* [Sitemap](https://en.wikipedia.org/wiki/Sitemaps) (including Sitemap index discovery and compressed sitemaps)

RSS Guard has also built-in support for [Gemini](https://geminiprotocol.net) protocol and hypertext format, so it can very well act as reliable cross-platform Gemini client! All you need to do is to make sure that proper `gemini://` scheme is used in your URLs. Gemini protocol is also used by internal feed fetching network stack, so you can even fetch feeds via the protocol.

When it comes to online web-based feed readers, these are supported:

| Service | Two-way Synchronization | Intelligent Synchronization Algorithm (ISA) [^1] | Synchronized Labels [^2] | OAuth [^3] |
Expand Down

0 comments on commit 8edd0f3

Please sign in to comment.