README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

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**.

TODO
----

- [ ] Custom entries sorting
- [ ] Webpage scraper (Readability)
- [X] Bookmarklet
- [ ] External integrations (Pinboard, Wallabag...)
- [ ] Gzip compression
- [ ] Integration tests
- [X] Flush history
- [ ] OAuth2

Credits
-------

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