aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Frédéric Guillot <fred@miniflux.net>2017-12-12 21:02:04 -0800
committerGravatar Frédéric Guillot <fred@miniflux.net>2017-12-12 21:02:04 -0800
commit9b1128d56dc2129a8cb90e882f67155ab74521b9 (patch)
tree2e7ece7ad8f526dd264cdf39670569e1e8529534 /README.md
parentef097f02fe76572d2b1887c28da3f2bd83a993a0 (diff)
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 9 insertions, 16 deletions
diff --git a/README.md b/README.md
index 6bf027d..7ccb847 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Miniflux is a minimalist and opinionated feed reader:
- Works only with Postgresql
- Doesn't use any ORM
- Doesn't use any complicated framework
-- Use only modern vanilla Javascript (ES6 and fetch)
+- Use only modern vanilla Javascript (ES6 and Fetch API)
- The number of features is volountary limited
It's simple, fast, lightweight and super easy to install.
@@ -21,24 +21,17 @@ 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)
-- [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
-- [X] Fever API
+- [Upgrading to a new version](https://docs.miniflux.net/en/latest/upgrade.html)
+- [Configuration](https://docs.miniflux.net/en/latest/configuration.html)
Credits
-------