summaryrefslogtreecommitdiff
path: root/Home.md
diff options
context:
space:
mode:
authorsupahgreg <supahgreg@users.noreply.github.com>2025-10-06 02:39:11 +0000
committersupahgreg <supahgreg@users.noreply.github.com>2025-10-06 02:39:11 +0000
commit96635e1ff46da225f11b5078da9a0b1e246a371d (patch)
tree2edc77e51746e36e03089eeca411e1582017d5a5 /Home.md
parentd5fa3da71c9e5e1b78a090aad0c71a7a9b90a437 (diff)
Home and Installation Guide content updates.
Diffstat (limited to 'Home.md')
-rw-r--r--Home.md36
1 files changed, 17 insertions, 19 deletions
diff --git a/Home.md b/Home.md
index baad3c3..3454cd9 100644
--- a/Home.md
+++ b/Home.md
@@ -1,4 +1,4 @@
-Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader and aggregator.
+Tiny Tiny RSS (tt-rss) is a free, flexible, open source, web-based news feed (RSS/Atom/other) reader and aggregator.
## Screenshots
@@ -26,31 +26,29 @@ Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader an
- and much more…
- ~~[[Android Client]]~~
-## Development
+## Installation
+
+You will need the following:
+* A modern web browser. This generally means a recent version of Chrome/Chromium or Firefox.
+* A system running Docker.
+
+See the [Docker installation guide](Installation-Notes) for detailed instructions.
-See https://github.com/supahgreg/tt-rss .
+> [!WARNING]
+> If you choose to run tt-rss without using Docker support might be limited.
+
+> [!INFO]
+> Tiny Tiny RSS uses a continuous development model based on the `main` branch, which is considered stable.
+> It's strongly recommended that you remain current-- meaning using either the most recent Docker image(s) or commit on `main`.
## Get in touch
* 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
-
-Contributions (code, translations, reporting issues, etc.) are welcome.
+## Development and Contributing
+* Contributions (code, translations, reporting issues, etc.) are welcome.
+* Development and issue tracking primarily happens in https://github.com/supahgreg/tt-rss .
* (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 a recent version of Chrome/Chromium or Firefox;
-* A server (VDS or physical) running Docker;
-
-### [Docker installation guide](Installation-Notes)
-
-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.