summaryrefslogtreecommitdiff
path: root/Home.md
diff options
context:
space:
mode:
Diffstat (limited to 'Home.md')
-rw-r--r--Home.md70
1 files changed, 30 insertions, 40 deletions
diff --git a/Home.md b/Home.md
index e7dc737..7ba26b9 100644
--- a/Home.md
+++ b/Home.md
@@ -1,66 +1,56 @@
----
-hide:
- - navigation
- - toc
----
-
-<style>
- .md-typeset h1,
- .md-content__button {
- display: none;
- }
-</style>
-
Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader and aggregator.
## Screenshots
-![](images/tt-rss/25.05/Screenshot_2025-05-10_at_09.22.19.webp){ width="350", align=left }
-![](images/tt-rss/25.05/Screenshot_2025-05-10_at_09.21.21.webp){ width="350", align=left }
-![](images/tt-rss/25.05/Screenshot_2025-05-10_at_09.22.50.webp){ width="350" }
+<img src="images/tt-rss/25.05/Screenshot_2025-05-10_at_09.22.19.webp" width="350" style="float: left">
+<img src="images/tt-rss/25.05/Screenshot_2025-05-10_at_09.21.21.webp" width="350" style="float: left">
+<img src="images/tt-rss/25.05/Screenshot_2025-05-10_at_09.22.50.webp" width="350">
## Features
-- Free software, licensed under [GNU GPLv3](http://www.gnu.org/copyleft/gpl.html);
-- Self-hosted: control your own data and protect your privacy instead of relying on third party services;
-- Supports:
- - organizing feeds by folders (and subfolders),
- - [feed aggregation / syndication](wiki/GeneratedFeeds.md),
- - keyboard shortcuts,
- - OPML import/export,
- - multiple ways to share stuff: export RSS feeds, plugins for various social sites, sharing by URL, etc,
- - [sharing arbitrary content through tt-rss](wiki/ShareAnything.md),
- - [Plugins](Plugins.md) and [themes](Themes.md),
- - embedding full article content via readability and site-specific plugins,
- - deduplication, including [perceptual hashing](https://github.com/supahgreg/tt-rss-plugin-perceptual-image-hash) for images,
- - podcasts,
- - [flexible article filtering](wiki/ContentFilters.md),
- - [JSON API](ApiReference.md),
- - and much more…
-- [Android client](AndroidClient.md);
+- Free software, licensed under [GNU GPLv3](http://www.gnu.org/copyleft/gpl.html)
+- Self-hosted: control your own data and protect your privacy instead of relying on third party services
+- Supports:
+ - organizing feeds by folders (and subfolders)
+ - [feed aggregation / syndication](Generated-Feeds)
+ - keyboard shortcuts
+ - OPML import/export
+ - multiple ways to share stuff: export RSS feeds, plugins for various social sites, sharing by URL, etc.
+ - [sharing arbitrary content through tt-rss](Share-Anything)
+ - [Plugins](Plugins) and [themes](Themes)
+ - embedding full article content via readability and site-specific plugins
+ - deduplication, including [perceptual hashing](https://github.com/supahgreg/tt-rss-plugin-perceptual-image-hash) for images
+ - podcasts
+ - [flexible article filtering](Content-Filters)
+ - [JSON API](Api-Reference)
+ - and much more…
+- ~~[[Android Client]]~~
## Development
-* https://github.com/supahgreg/tt-rss
+See https://github.com/supahgreg/tt-rss .
## Get in touch
-Join https://github.com/supahgreg/tt-rss/discussions if you have questions or need to report a bug.
+* Go to https://github.com/supahgreg/tt-rss/discussions if you have questions or want to discuss something.
+* Go to https://github.com/supahgreg/tt-rss/issues if you want to report an issue, request an enhancement/feature, etc.
## Contribute
-<!-- * Help translate tt-rss into your own language using [Weblate](https://hosted.weblate.org/engage/tt-rss/); -->
-* [Code contribution guidelines](https://github.com/supahgreg/tt-rss/blob/main/CONTRIBUTING.md);
+Contributions (code, translations, reporting issues, etc.) are welcome.
+
+* (not quite ready for this post-`tt-rss.org`) ~~Help translate tt-rss into your own language using [Weblate](https://hosted.weblate.org/engage/tt-rss/)~~
+* [Code contribution guidelines](https://github.com/supahgreg/tt-rss/blob/main/CONTRIBUTING.md)
## Installation
You will need the following:
-* A modern web browser. This generally means recent Chrome or compatible;
+* A modern web browser. This generally means a recent version of Chrome/Chromium or Firefox;
* A server (VDS or physical) running Docker;
-### [Docker installation guide](wiki/InstallationNotes.md)
+### [Docker installation guide](Installation-Notes)
-Tiny Tiny RSS uses continuous development model based on a `main` branch, which is considered stable. If possible, you should always be running latest main branch code.
+Tiny Tiny RSS uses a continuous development model based on the `main` branch, which is considered stable. If possible, you should always be running the latest `main` branch code.
There’s no warranty. If it breaks you get to keep both parts.