miniflux/README.md

48 lines
1.3 KiB
Markdown
Raw Normal View History

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)
2017-11-21 22:28:52 +01:00
[![Documentation Status](https://readthedocs.org/projects/miniflux/badge/?version=latest)](https://docs.miniflux.net/)
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
2017-11-22 00:46:59 +01:00
- Use only modern vanilla Javascript (ES6 and fetch)
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**.
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/)
2017-11-20 06:10:04 +01:00
TODO
----
2017-12-03 02:04:01 +01:00
- [X] Custom entries sorting
2017-11-20 06:10:04 +01:00
- [ ] Webpage scraper (Readability)
2017-11-22 04:37:47 +01:00
- [X] Bookmarklet
- [ ] External integrations (Pinboard, Instapaper, Pocket?)
2017-11-20 06:10:04 +01:00
- [ ] Gzip compression
2017-11-27 00:07:59 +01:00
- [X] Integration tests
2017-11-22 00:46:59 +01:00
- [X] Flush history
- [X] OAuth2
2017-12-03 02:04:01 +01:00
- [X] Touch events
2017-11-27 00:07:59 +01:00
- [ ] Fever API?
2017-11-20 06:10:04 +01:00
Credits
-------
- Author: Frédéric Guillot
- Distributed under Apache 2.0 License