miniflux-legacy/README.markdown

Miniflux - Minimalist News Reader
=================================

Miniflux is a minimalist and web-based RSS reader.

Features
--------

### Host almost anywhere

- Your Raspberry Pi, a shared web-hosting, a virtual machine or localhost
- Easy setup => copy and paste the source code and you are done!
- Use a lightweight Sqlite database instead of Mysql or Postgresql
- Auto-update from the user interface

### Readability

- CSS optimized for readability
- Responsive design

### Privacy and security

- Remove Feedburner Ads and analytics trackers (1x1 pixels)
- Open external links inside a new tab with a `rel="noreferrer"` attribute
- Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
- Article content is filtered before being displayed

### Polyglot

- Translated in English, French, German, Italian, Czech, Spanish, Portuguese and Simplified Chinese
- RTL languages support

### Users management

- Alternate authentication with a Google Account or Mozilla Persona
- Multiple databases (each user has his own database)

### Awesome features

- Keyboard shortcuts
- Full article download for feeds that display only a summary
- Enclosure support (videos and podcasts)
- Feed updates via a cronjob or with the user interface with one click

### More

- Keeps history of read items
- Basic bookmarks
- Import/Export of OPML feeds
- Themes

Requirements
------------

- Recent version of libxml2 >= 2.7.x (version 2.6.32 on Debian Lenny is not supported anymore)
- PHP >= 5.3.3
- PHP XML extensions (SimpleXML, DOM...)
- PHP Sqlite extension
- cURL extension for PHP or Stream Context with `allow_url_fopen=On`

Documentation
-------------

- [Installation and updates](docs/installation-and-updates.markdown)
- [Cronjob](docs/cronjob.markdown)
- [Advanced configuration](docs/config.markdown)
- [Full article download](docs/full-article-download.markdown)
- [Multiple users](docs/multiple-users.markdown)
- [Translations](docs/translations.markdown)
- [Themes](docs/themes.markdown)
- [Session](docs/session.markdown)
- [API documentation](http://miniflux.net/api.html)
- [FAQ](docs/faq.markdown)

Todo and known bugs
-------------------

- See Issues: <https://github.com/fguillot/miniflux/issues>

License
-------

- AGPL: <http://www.gnu.org/licenses/agpl-3.0.txt>

Authors
-------

Original author: [Frédéric Guillot](http://fredericguillot.com/)

### Contributors

People who sent a pull-request, report a bug, make a new theme or share a super cool idea:

- André Kelpe: https://github.com/fs111
- Ayodio: https://github.com/ayodio
- Bjauy: https://github.com/bjauy
- Bohwaz: https://github.com/bohwaz
- Chase Arnold: https://github.com/chase4926
- Chris Lemonier: https://github.com/chrislemonier
- Delehef: https://github.com/delehef
- Derjus: https://github.com/derjus
- Eauland: https://github.com/eauland
- Félix: https://github.com/dysosmus
- Geriel Castro: https://github.com/GerielCastro
- Hika0: https://github.com/hika0
- Horsely: https://github.com/horsley
- Ing. Jan Kaláb: https://github.com/Pitel
- Itoine: https://github.com/itoine
- James Scott-Brown: https://github.com/jamesscottbrown
- Luca Marra: https://github.com/facciocose
- Maxime: https://github.com/EpocDotFr
- MonsieurPaulLeBoulanger: https://github.com/MonsieurPaulLeBoulanger
- Necku: https://github.com/Necku
- Nicolas Dewaele: http://adminrezo.fr/
- Pcwalden: https://github.com/pcwalden
- Pitel: https://github.com/Pitel
- Silvus: https://github.com/Silvus
- Skasi7: https://github.com/skasi7
- Thiriot Christophe: https://github.com/doubleface
- Tobi: https://github.com/tobir
- Vincent Ozanam
- Ygbillet: https://github.com/ygbillet

Many people also sent bug reports and feature requests.
Big update 2013-03-17 23:16:25 +01:00			`Miniflux - Minimalist News Reader`
first commit 2013-02-18 03:48:21 +01:00			`=================================`

Improve documentation 2014-04-06 18:02:45 +02:00			`Miniflux is a minimalist and web-based RSS reader.`
first commit 2013-02-18 03:48:21 +01:00
			`Features`
			`--------`

Improve documentation 2014-04-06 18:02:45 +02:00			`### Host almost anywhere`

			`- Your Raspberry Pi, a shared web-hosting, a virtual machine or localhost`
			`- Easy setup => copy and paste the source code and you are done!`
			`- Use a lightweight Sqlite database instead of Mysql or Postgresql`
			`- Auto-update from the user interface`

			`### Readability`

first commit 2013-02-18 03:48:21 +01:00			`- CSS optimized for readability`
Improve documentation 2014-04-06 18:02:45 +02:00			`- Responsive design`

			`### Privacy and security`

			`- Remove Feedburner Ads and analytics trackers (1x1 pixels)`
Update readme 2013-02-24 20:09:16 +01:00			- Open external links inside a new tab with a `rel="noreferrer"` attribute
Improve documentation 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`

			`### Polyglot`

Update readme and merge Portuguese translation 2013-10-02 00:47:33 +02:00			`- Translated in English, French, German, Italian, Czech, Spanish, Portuguese and Simplified Chinese`
Update of PicoFeed 2014-03-17 03:17:44 +01:00			`- RTL languages support`
Improve documentation 2014-04-06 18:02:45 +02:00
			`### Users management`

			`- Alternate authentication with a Google Account or Mozilla Persona`
Add support for multiple users/databases 2014-04-06 02:24:13 +02:00			`- Multiple databases (each user has his own database)`
first commit 2013-02-18 03:48:21 +01:00
Improve documentation 2014-04-06 18:02:45 +02:00			`### Awesome features`

			`- Keyboard shortcuts`
Improve content grabber 2014-04-16 00:15:31 +02:00			`- Full article download for feeds that display only a summary`
			`- Enclosure support (videos and podcasts)`
Improve documentation 2014-04-06 18:02:45 +02:00			`- Feed updates via a cronjob or with the user interface with one click`

			`### More`

			`- Keeps history of read items`
			`- Basic bookmarks`
			`- Import/Export of OPML feeds`
			`- Themes`

			`Requirements`
			`------------`

			`- Recent version of libxml2 >= 2.7.x (version 2.6.32 on Debian Lenny is not supported anymore)`
			`- PHP >= 5.3.3`
			`- PHP XML extensions (SimpleXML, DOM...)`
			`- PHP Sqlite extension`
			- cURL extension for PHP or Stream Context with `allow_url_fopen=On`

			`Documentation`
			`-------------`

			`- [Installation and updates](docs/installation-and-updates.markdown)`
			`- [Cronjob](docs/cronjob.markdown)`
			`- [Advanced configuration](docs/config.markdown)`
			`- [Full article download](docs/full-article-download.markdown)`
			`- [Multiple users](docs/multiple-users.markdown)`
			`- [Translations](docs/translations.markdown)`
			`- [Themes](docs/themes.markdown)`
			`- [Session](docs/session.markdown)`
			`- [API documentation](http://miniflux.net/api.html)`
			`- [FAQ](docs/faq.markdown)`

Update readme 2013-04-06 03:52:58 +02:00			`Todo and known bugs`
			`-------------------`
first commit 2013-02-18 03:48:21 +01:00
Update readme 2013-04-06 03:52:58 +02:00			`- See Issues: <https://github.com/fguillot/miniflux/issues>`
first commit 2013-02-18 03:48:21 +01:00
Add license 2013-03-17 23:30:07 +01:00			`License`
			`-------`

			`- AGPL: <http://www.gnu.org/licenses/agpl-3.0.txt>`

Add author section to the readme 2013-04-06 03:58:17 +02:00			`Authors`
			`-------`

Add list of contributors to the readme 2013-07-09 00:31:25 +02:00			`Original author: [Frédéric Guillot](http://fredericguillot.com/)`

			`### Contributors`

Minor css improvements 2013-09-19 23:54:50 +02:00			`People who sent a pull-request, report a bug, make a new theme or share a super cool idea:`
Add list of contributors to the readme 2013-07-09 00:31:25 +02:00
			`- André Kelpe: https://github.com/fs111`
			`- Ayodio: https://github.com/ayodio`
Update list of contributors 2013-08-04 20:26:46 +02:00			`- Bjauy: https://github.com/bjauy`
Add a preference parameter to save default items sorting order 2013-09-19 03:02:46 +02:00			`- Bohwaz: https://github.com/bohwaz`
Update contributors list 2013-08-18 18:28:15 +02:00			`- Chase Arnold: https://github.com/chase4926`
Update readme 2013-07-20 03:01:55 +02:00			`- Chris Lemonier: https://github.com/chrislemonier`
Add contributor 2013-11-23 04:49:52 +01:00			`- Delehef: https://github.com/delehef`
Add list of contributors to the readme 2013-07-09 00:31:25 +02:00			`- Derjus: https://github.com/derjus`
			`- Eauland: https://github.com/eauland`
			`- Félix: https://github.com/dysosmus`
Update readme and merge Portuguese translation 2013-10-02 00:47:33 +02:00			`- Geriel Castro: https://github.com/GerielCastro`
Add more grabber rules: dozodomo.com, ffworld.com, kanpai.fr and lejapon.fr 2014-03-20 01:10:11 +01:00			`- Hika0: https://github.com/hika0`
Add list of contributors to the readme 2013-07-09 00:31:25 +02:00			`- Horsely: https://github.com/horsley`
Update list of contributors 2013-07-14 18:35:11 +02:00			`- Ing. Jan Kaláb: https://github.com/Pitel`
Add a preference parameter to save default items sorting order 2013-09-19 03:02:46 +02:00			`- Itoine: https://github.com/itoine`
Improve help popup (pull-request) 2013-07-21 17:11:41 +02:00			`- James Scott-Brown: https://github.com/jamesscottbrown`
Add list of contributors to the readme 2013-07-09 00:31:25 +02:00			`- Luca Marra: https://github.com/facciocose`
Update contributors list 2013-07-20 15:10:17 +02:00			`- Maxime: https://github.com/EpocDotFr`
Add list of contributors to the readme 2013-07-09 00:31:25 +02:00			`- MonsieurPaulLeBoulanger: https://github.com/MonsieurPaulLeBoulanger`
			`- Necku: https://github.com/Necku`
Add new theme: Copper (By Nicolas Dewaele) 2013-11-12 02:38:54 +01:00			`- Nicolas Dewaele: http://adminrezo.fr/`
Improve enclosure support 2014-02-18 04:04:49 +01:00			`- Pcwalden: https://github.com/pcwalden`
Add contributor 2014-02-28 23:41:25 +01:00			`- Pitel: https://github.com/Pitel`
Rename theme Bootstrap-3 in Bootstrap-light 2013-09-19 01:55:59 +02:00			`- Silvus: https://github.com/Silvus`
Add contributor 2013-12-18 03:45:03 +01:00			`- Skasi7: https://github.com/skasi7`
Add list of contributors to the readme 2013-07-09 00:31:25 +02:00			`- Thiriot Christophe: https://github.com/doubleface`
Add grabber rule for heise.de 2014-05-17 15:26:17 +02:00			`- Tobi: https://github.com/tobir`
Add spanish translation (contribution of Vincent O.) 2013-10-01 03:30:23 +02:00			`- Vincent Ozanam`
Add list of contributors to the readme 2013-07-09 00:31:25 +02:00			`- Ygbillet: https://github.com/ygbillet`

Split the documentation in multiple files 2014-04-06 03:58:17 +02:00			`Many people also sent bug reports and feature requests.`