aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Frédéric Guillot <fred@miniflux.net>2017-11-19 21:10:04 -0800
committerGravatar Frédéric Guillot <fred@miniflux.net>2017-11-19 22:01:46 -0800
commit8ffb773f43c8dc54801ca1d111854e7e881c93c9 (patch)
tree38133a2fc612597a75fed1d13e5b4042f58a2b7e /README.md
First commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..414d88d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+Miniflux 2
+==========
+[![Build Status](https://travis-ci.org/miniflux/miniflux2.svg?branch=master)](https://travis-ci.org/miniflux/miniflux2)
+
+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
+- 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)
+- [ ] Bookmarklet
+- [ ] External integrations (Pinboard, Wallabag...)
+- [ ] Gzip compression
+- [ ] Integration tests
+- [ ] Flush history
+- [ ] OAuth2
+
+Credits
+-------
+
+- Author: Frédéric Guillot
+- Distributed under Apache 2.0 License