miniflux-v2/README.md

Miniflux 2
==========
[![Build Status](https://travis-ci.org/miniflux/miniflux2.svg?branch=master)](https://travis-ci.org/miniflux/miniflux2)
[![Documentation Status](https://readthedocs.org/projects/miniflux/badge/?version=latest)](https://docs.miniflux.net/)

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
- Use only modern vanilla Javascript (ES6 and fetch)
- The number of features is volountary limited

It's simple, fast, lightweight and super easy to install.

Miniflux 2 is a rewrite of Miniflux 1.x in Golang.

Notes
-----

Miniflux 2 still in development and **it's not ready to use**.

- [Features](https://docs.miniflux.net/en/latest/features.html)
- [Requirements](https://docs.miniflux.net/en/latest/requirements.html)
- [Installation](https://docs.miniflux.net/en/latest/installation.html)
- [Documentation](https://docs.miniflux.net/)

TODO
----

- [X] Custom entries sorting
- [ ] Webpage scraper (Readability)
- [X] Bookmarklet
- [ ] External integrations (Pinboard, Instapaper, Pocket?)
- [ ] Gzip compression
- [X] Integration tests
- [X] Flush history
- [X] OAuth2
- [X] Touch events
- [X] Fever API

Credits
-------

- Author: Frédéric Guillot
- Distributed under Apache 2.0 License
First commit 2017-11-20 06:10:04 +01:00			`Miniflux 2`
			`==========`
			`[![Build Status](https://travis-ci.org/miniflux/miniflux2.svg?branch=master)](https://travis-ci.org/miniflux/miniflux2)`
Add badge for documentation 2017-11-21 22:28:52 +01:00			`[![Documentation Status](https://readthedocs.org/projects/miniflux/badge/?version=latest)](https://docs.miniflux.net/)`
First commit 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`
Add flush history feature 2017-11-22 00:46:59 +01:00			`- Use only modern vanilla Javascript (ES6 and fetch)`
First commit 2017-11-20 06:10:04 +01:00			`- The number of features is volountary limited`

			`It's simple, fast, lightweight and super easy to install.`

			`Miniflux 2 is a rewrite of Miniflux 1.x in Golang.`

			`Notes`
			`-----`

			`Miniflux 2 still in development and it's not ready to use.`

Make entries sorting configurable 2017-12-03 02:04:01 +01:00			`- [Features](https://docs.miniflux.net/en/latest/features.html)`
			`- [Requirements](https://docs.miniflux.net/en/latest/requirements.html)`
			`- [Installation](https://docs.miniflux.net/en/latest/installation.html)`
			`- [Documentation](https://docs.miniflux.net/)`

First commit 2017-11-20 06:10:04 +01:00			`TODO`
			`----`

Make entries sorting configurable 2017-12-03 02:04:01 +01:00			`- [X] Custom entries sorting`
First commit 2017-11-20 06:10:04 +01:00			`- [ ] Webpage scraper (Readability)`
Add bookmarklet 2017-11-22 04:37:47 +01:00			`- [X] Bookmarklet`
Store tokens in database instead of cookie 2017-12-02 06:51:22 +01:00			`- [ ] External integrations (Pinboard, Instapaper, Pocket?)`
First commit 2017-11-20 06:10:04 +01:00			`- [ ] Gzip compression`
Add integration tests for entries 2017-11-27 00:07:59 +01:00			`- [X] Integration tests`
Add flush history feature 2017-11-22 00:46:59 +01:00			`- [X] Flush history`
Add integration tests for feed creation 2017-11-26 01:53:51 +01:00			`- [X] OAuth2`
Make entries sorting configurable 2017-12-03 02:04:01 +01:00			`- [X] Touch events`
Add Fever API 2017-12-04 02:44:27 +01:00			`- [X] Fever API`
First commit 2017-11-20 06:10:04 +01:00
			`Credits`
			`-------`

			`- Author: Frédéric Guillot`
			`- Distributed under Apache 2.0 License`