miniflux/README.md
2017-12-02 17:04:01 -08:00

47 lines
1.3 KiB
Markdown

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
- [ ] Fever API?
Credits
-------
- Author: Frédéric Guillot
- Distributed under Apache 2.0 License