diff options
Diffstat (limited to 'Home.md')
| -rw-r--r-- | Home.md | 67 |
1 files changed, 66 insertions, 1 deletions
@@ -1 +1,66 @@ -Welcome to the tt-rss wiki! +--- +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 + +{ width="350", align=left } +{ width="350", align=left } +{ 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); + +## Development + +* 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. + +## 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); + +## Installation + +You will need the following: + +* A modern web browser. This generally means recent Chrome or compatible; +* A server (VDS or physical) running Docker; + +### [Docker installation guide](wiki/InstallationNotes.md) + +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. + +There’s no warranty. If it breaks you get to keep both parts. |