2017-11-20 06:10:04 +01:00
|
|
|
Miniflux 2
|
|
|
|
==========
|
2017-12-13 06:48:13 +01:00
|
|
|
[![Build Status](https://travis-ci.org/miniflux/miniflux.svg?branch=master)](https://travis-ci.org/miniflux/miniflux)
|
2018-08-25 06:51:50 +02:00
|
|
|
[![GoDoc](https://godoc.org/miniflux.app?status.svg)](https://godoc.org/miniflux.app)
|
2017-11-20 06:10:04 +01:00
|
|
|
|
|
|
|
Miniflux is a minimalist and opinionated feed reader:
|
|
|
|
|
|
|
|
- Written in Go (Golang)
|
|
|
|
- Works only with Postgresql
|
|
|
|
- Doesn't use any ORM
|
|
|
|
- Doesn't use any complicated framework
|
2017-12-13 06:02:04 +01:00
|
|
|
- Use only modern vanilla Javascript (ES6 and Fetch API)
|
2018-07-19 02:28:57 +02:00
|
|
|
- Single binary compiled statically without dependency
|
2017-12-26 16:40:44 +01:00
|
|
|
- The number of features is voluntarily limited
|
2017-11-20 06:10:04 +01:00
|
|
|
|
|
|
|
It's simple, fast, lightweight and super easy to install.
|
|
|
|
|
2018-07-19 02:28:57 +02:00
|
|
|
Official website: <https://miniflux.app>
|
|
|
|
|
2017-12-13 06:02:04 +01:00
|
|
|
Documentation
|
|
|
|
-------------
|
|
|
|
|
2019-04-23 05:37:58 +02:00
|
|
|
The Miniflux documentation is available here: <https://miniflux.app/docs/> ([Man page](https://miniflux.app/miniflux.1.html))
|
|
|
|
|
|
|
|
- [Opinionated?](https://miniflux.app/opinionated.html)
|
|
|
|
- [Features](https://miniflux.app/features.html)
|
|
|
|
- [Requirements](https://miniflux.app/docs/requirements.html)
|
|
|
|
- [Installation Instructions](https://miniflux.app/docs/installation.html)
|
|
|
|
- [Upgrading to a New Version](https://miniflux.app/docs/upgrade.html)
|
|
|
|
- [Configuration](https://miniflux.app/docs/configuration.html)
|
|
|
|
- [Command Line Usage](https://miniflux.app/docs/cli.html)
|
|
|
|
- [User Interface Usage](https://miniflux.app/docs/ui.html)
|
|
|
|
- [Keyboard Shortcuts](https://miniflux.app/docs/keyboard_shortcuts.html)
|
|
|
|
- [Integration with External Services](https://miniflux.app/docs/services.html)
|
|
|
|
- [Rewrite and Scraper Rules](https://miniflux.app/docs/rules.html)
|
|
|
|
- [API Reference](https://miniflux.app/docs/api.html)
|
|
|
|
- [Development](https://miniflux.app/docs/development.html)
|
|
|
|
- [Internationalization](https://miniflux.app/docs/i18n.html)
|
|
|
|
- [Frequently Asked Questions](https://miniflux.app/faq.html)
|
2018-08-27 02:18:17 +02:00
|
|
|
|
|
|
|
Screenshots
|
|
|
|
-----------
|
|
|
|
|
|
|
|
Default theme:
|
|
|
|
|
2019-04-23 05:37:58 +02:00
|
|
|
![Default theme](https://miniflux.app/images/overview.png)
|
2018-08-27 02:18:17 +02:00
|
|
|
|
2018-11-11 14:51:54 +01:00
|
|
|
Dark theme when using keyboard navigation:
|
2018-08-27 02:18:17 +02:00
|
|
|
|
2019-04-23 05:37:58 +02:00
|
|
|
![Dark theme](https://miniflux.app/images/item-selection-black-theme.png)
|
2017-11-20 06:10:04 +01:00
|
|
|
|
|
|
|
Credits
|
|
|
|
-------
|
|
|
|
|
2018-08-27 02:18:17 +02:00
|
|
|
- Authors: Frédéric Guillot - [List of contributors](https://github.com/miniflux/miniflux/graphs/contributors)
|
2017-11-20 06:10:04 +01:00
|
|
|
- Distributed under Apache 2.0 License
|