aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 23 insertions, 4 deletions
diff --git a/README.md b/README.md
index 02eceb1..c1499df 100644
--- a/README.md
+++ b/README.md
@@ -18,8 +18,6 @@ It's simple, fast, lightweight and super easy to install.
Official website: <https://miniflux.app>
-Miniflux 2 is a rewrite of [Miniflux 1.x](https://github.com/miniflux/miniflux-legacy) in Golang.
-
Documentation
-------------
@@ -30,11 +28,32 @@ The Miniflux documentation is available here: <https://docs.miniflux.app/>
- [Requirements](https://docs.miniflux.app/en/latest/requirements.html)
- [Installation Instructions](https://docs.miniflux.app/en/latest/installation.html)
- [Installation Tutorials](https://docs.miniflux.app/en/latest/tutorials.html)
-- [Upgrading to a new version](https://docs.miniflux.app/en/latest/upgrade.html)
+- [Upgrading to a New Version](https://docs.miniflux.app/en/latest/upgrade.html)
- [Configuration](https://docs.miniflux.app/en/latest/configuration.html)
+- [Command Line Usage](https://docs.miniflux.app/en/latest/cli.html)
+- [User Interface Usage](https://docs.miniflux.app/en/latest/usage.html)
+- [Keyboard Shortcuts](https://docs.miniflux.app/en/latest/keyboard_shortcuts.html)
+- [Integration with External Services](https://docs.miniflux.app/en/latest/integration.html)
+- [Scraper Rules](https://docs.miniflux.app/en/latest/scraper_rules.html)
+- [Rewrite Rules](https://docs.miniflux.app/en/latest/rewrite_rules.html)
+- [REST API](https://docs.miniflux.app/en/latest/api.html)
+- [Development](https://docs.miniflux.app/en/latest/development.html)
+- [Internationalization](https://docs.miniflux.app/en/latest/i18n.html)
+- [Frequently Asked Questions](https://docs.miniflux.app/en/latest/faq.html)
+
+Screenshots
+-----------
+
+Default theme:
+
+![Default theme](https://miniflux.app/image/overview.png)
+
+Dark theme when using keyboard naviguation:
+
+![Dark theme](https://miniflux.app/image/item-selection-black-theme.png)
Credits
-------
-- Author: Frédéric Guillot
+- Authors: Frédéric Guillot - [List of contributors](https://github.com/miniflux/miniflux/graphs/contributors)
- Distributed under Apache 2.0 License