miniflux-legacy/README.markdown

60 lines
2.8 KiB
Markdown
Raw Normal View History

2013-03-17 23:16:25 +01:00
Miniflux - Minimalist News Reader
2013-02-18 03:48:21 +01:00
=================================
2017-12-30 00:17:38 +01:00
[![Build Status](https://travis-ci.org/miniflux/miniflux-legacy.svg?branch=master)](https://travis-ci.org/miniflux/miniflux-legacy)
2014-04-06 18:02:45 +02:00
Miniflux is a minimalist and web-based RSS reader.
2013-02-18 03:48:21 +01:00
Features
--------
2016-12-30 00:52:37 +01:00
- Self-hosted
2015-04-06 19:51:02 +02:00
- Readability (CSS optimized for readability, responsive design, compatible with mobile and tablet devices)
- Easy setup => **copy and paste the source code and you are done!**
2015-12-08 03:05:31 +01:00
- Remove Feedburner Ads and analytic trackers (1x1 pixels)
2013-02-24 20:09:16 +01:00
- Open external links inside a new tab with a `rel="noreferrer"` attribute
2014-04-06 18:02:45 +02:00
- Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
- Article content is filtered before being displayed
2016-03-09 04:18:47 +01:00
- Translated in Arabic, English, French, German, Italian, Japanese, Czech, Spanish, Turkish, Portuguese, Russian, Serbian and Simplified Chinese
2014-03-17 03:17:44 +01:00
- RTL languages support
2014-04-06 18:02:45 +02:00
- Keyboard shortcuts
2014-04-16 00:15:31 +02:00
- Full article download for feeds that display only a summary
2014-12-24 20:44:40 +01:00
- Bookmarks
- Groups for categorization of feeds (like folders or tags)
2017-06-16 07:50:10 +02:00
- Send your favorite articles to Pinboard, Instapaper, Shaarli or Wallabag
2014-04-16 00:15:31 +02:00
- Enclosure support (videos and podcasts)
2016-12-30 00:52:37 +01:00
- Feed updates via a cronjob or with the user interface in one click
2014-04-06 18:02:45 +02:00
- Keeps history of read items
- Import/Export of OPML feeds
- Themes
- Multiple users
- Image proxy to avoid mixed content warnings with HTTPS
2014-04-06 18:02:45 +02:00
Documentation
-------------
2017-12-28 07:34:57 +01:00
- [ChangeLog](https://github.com/miniflux/miniflux-legacy/blob/master/ChangeLog)
- [Installation and Requirements](https://github.com/miniflux/miniflux-legacy/blob/master/docs/installation.markdown)
- [Upgrade to a new version](https://github.com/miniflux/miniflux-legacy/blob/master/docs/upgrade.markdown)
- [Cronjob](https://github.com/miniflux/miniflux-legacy/blob/master/docs/cronjob.markdown)
- [Advanced configuration](https://github.com/miniflux/miniflux-legacy/blob/master/docs/config.markdown)
- [Full article download](https://github.com/miniflux/miniflux-legacy/blob/master/docs/full-article-download.markdown)
- [Translations](https://github.com/miniflux/miniflux-legacy/blob/master/docs/translations.markdown)
- [Themes](https://github.com/miniflux/miniflux-legacy/blob/master/docs/themes.markdown)
- [Json-RPC API](https://github.com/miniflux/miniflux-legacy/blob/master/docs/json-rpc-api.markdown)
- [Fever API](https://github.com/miniflux/miniflux-legacy/blob/master/docs/fever.markdown)
- [Run Miniflux with Docker](https://github.com/miniflux/miniflux-legacy/blob/master/docs/docker.markdown)
- [FAQ](https://github.com/miniflux/miniflux-legacy/blob/master/docs/faq.markdown)
2014-04-06 18:02:45 +02:00
2013-03-17 23:30:07 +01:00
License
-------
2015-06-21 15:36:53 +02:00
- AGPLv3: <http://www.gnu.org/licenses/agpl-3.0.txt>
2013-03-17 23:30:07 +01:00
2013-04-06 03:58:17 +02:00
Authors
-------
- Original author: Frédéric Guillot
- [List of contributors](https://github.com/miniflux/miniflux/graphs/contributors)
2013-07-09 00:31:25 +02:00