diff options
| author |  Frédéric Guillot <fred@miniflux.net> | 2018-08-26 17:18:17 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2018-08-26 17:18:17 -0700 |
| commit | 4f62a704e2cb77e2c9d99c6f9fa45f3485cf0af7 (patch) | |
| tree | e323e983b963225e0e427c356f47e40711b029c2 /README.md | |
| parent | a3f3f51c60e91f22cc57ecc23cf828421d46b6b7 (diff) | |
Improve readme
- Add more links to the docs
- Add screenshots
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 23 insertions, 4 deletions
@@ -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: + + + +Dark theme when using keyboard naviguation: + + 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 |