miniflux/README.md
Thomas 5a721e694b Spelling correction on README.md
Corrected the spelling of 'voluntarily'.
2017-12-26 12:14:28 -08:00

40 lines
1.4 KiB
Markdown

Miniflux 2
==========
[![Build Status](https://travis-ci.org/miniflux/miniflux.svg?branch=master)](https://travis-ci.org/miniflux/miniflux)
[![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 API)
- The number of features is voluntarily limited
It's simple, fast, lightweight and super easy to install.
Miniflux 2 is a rewrite of [Miniflux 1.x](https://github.com/miniflux/miniflux-legacy) in Golang.
Notes
-----
Miniflux 2 still in development and **it's not ready to use**.
Documentation
-------------
The Miniflux documentation is available here: <https://docs.miniflux.net/>
- [Opinionated?](https://docs.miniflux.net/en/latest/opinionated.html)
- [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)
- [Upgrading to a new version](https://docs.miniflux.net/en/latest/upgrade.html)
- [Configuration](https://docs.miniflux.net/en/latest/configuration.html)
Credits
-------
- Author: Frédéric Guillot
- Distributed under Apache 2.0 License