1
0
Fork 0
miniflux/README.md

38 lines
1.5 KiB
Markdown
Raw Normal View History

2017-11-20 00:10:04 -05:00
Miniflux 2
==========
2017-12-13 00:48:13 -05:00
[![Build Status](https://travis-ci.org/miniflux/miniflux.svg?branch=master)](https://travis-ci.org/miniflux/miniflux)
2018-01-11 22:21:20 -05:00
[![GoDoc](https://godoc.org/github.com/miniflux/miniflux?status.svg)](https://godoc.org/github.com/miniflux/miniflux)
2017-11-21 16:28:52 -05:00
[![Documentation Status](https://readthedocs.org/projects/miniflux/badge/?version=latest)](https://docs.miniflux.net/)
2017-11-20 00:10:04 -05: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-12-13 00:02:04 -05:00
- Use only modern vanilla Javascript (ES6 and Fetch API)
- The number of features is voluntarily limited
2017-11-20 00:10:04 -05:00
It's simple, fast, lightweight and super easy to install.
2017-12-13 00:48:13 -05:00
Miniflux 2 is a rewrite of [Miniflux 1.x](https://github.com/miniflux/miniflux-legacy) in Golang.
2017-11-20 00:10:04 -05:00
2017-12-13 00:02:04 -05:00
Documentation
-------------
The Miniflux documentation is available here: <https://docs.miniflux.net/>
- [Opinionated?](https://docs.miniflux.net/en/latest/opinionated.html)
2017-12-02 20:04:01 -05:00
- [Features](https://docs.miniflux.net/en/latest/features.html)
- [Requirements](https://docs.miniflux.net/en/latest/requirements.html)
2018-05-19 18:47:46 -04:00
- [Installation Instructions](https://docs.miniflux.net/en/latest/installation.html)
- [Installation Tutorials](https://docs.miniflux.net/en/latest/tutorials.html)
2017-12-13 00:02:04 -05:00
- [Upgrading to a new version](https://docs.miniflux.net/en/latest/upgrade.html)
- [Configuration](https://docs.miniflux.net/en/latest/configuration.html)
2017-11-20 00:10:04 -05:00
Credits
-------
- Author: Frédéric Guillot
- Distributed under Apache 2.0 License