Browse Source

Improve readme

- Add more links to the docs
- Add screenshots
Frédéric Guillot 7 months ago
parent
commit
4f62a704e2
No account linked to committer's email address
1 changed files with 23 additions and 4 deletions
  1. 23
    4
      README.md

+ 23
- 4
README.md View File

@@ -18,8 +18,6 @@ It's simple, fast, lightweight and super easy to install.
18 18
 
19 19
 Official website: <https://miniflux.app>
20 20
 
21
-Miniflux 2 is a rewrite of [Miniflux 1.x](https://github.com/miniflux/miniflux-legacy) in Golang.
22
-
23 21
 Documentation
24 22
 -------------
25 23
 
@@ -30,11 +28,32 @@ The Miniflux documentation is available here: <https://docs.miniflux.app/>
30 28
 - [Requirements](https://docs.miniflux.app/en/latest/requirements.html)
31 29
 - [Installation Instructions](https://docs.miniflux.app/en/latest/installation.html)
32 30
 - [Installation Tutorials](https://docs.miniflux.app/en/latest/tutorials.html)
33
-- [Upgrading to a new version](https://docs.miniflux.app/en/latest/upgrade.html)
31
+- [Upgrading to a New Version](https://docs.miniflux.app/en/latest/upgrade.html)
34 32
 - [Configuration](https://docs.miniflux.app/en/latest/configuration.html)
33
+- [Command Line Usage](https://docs.miniflux.app/en/latest/cli.html)
34
+- [User Interface Usage](https://docs.miniflux.app/en/latest/usage.html)
35
+- [Keyboard Shortcuts](https://docs.miniflux.app/en/latest/keyboard_shortcuts.html)
36
+- [Integration with External Services](https://docs.miniflux.app/en/latest/integration.html)
37
+- [Scraper Rules](https://docs.miniflux.app/en/latest/scraper_rules.html)
38
+- [Rewrite Rules](https://docs.miniflux.app/en/latest/rewrite_rules.html)
39
+- [REST API](https://docs.miniflux.app/en/latest/api.html)
40
+- [Development](https://docs.miniflux.app/en/latest/development.html)
41
+- [Internationalization](https://docs.miniflux.app/en/latest/i18n.html)
42
+- [Frequently Asked Questions](https://docs.miniflux.app/en/latest/faq.html)
43
+
44
+Screenshots
45
+-----------
46
+
47
+Default theme:
48
+
49
+![Default theme](https://miniflux.app/image/overview.png)
50
+
51
+Dark theme when using keyboard naviguation:
52
+
53
+![Dark theme](https://miniflux.app/image/item-selection-black-theme.png)
35 54
 
36 55
 Credits
37 56
 -------
38 57
 
39
-- Author: Frédéric Guillot
58
+- Authors: Frédéric Guillot - [List of contributors](https://github.com/miniflux/miniflux/graphs/contributors)
40 59
 - Distributed under Apache 2.0 License

Loading…
Cancel
Save