From 12ea429436d3dbe392a38b7fe4d5f2d9c14e8a13 Mon Sep 17 00:00:00 2001
From: Antoine Fontaine <antoine.fontaine@epfl.ch>
Date: Tue, 20 Aug 2019 23:41:49 +0200
Subject: [PATCH] Updated README

---
 README.md | 26 +++++++++++---------------
 1 file changed, 11 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 13b7283..3059122 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,7 @@
 
 # Moody #
 
-This software is in alpha: it still has some rough edges.
-For example the username setup require restarting the app; I ignore why.
+A fast, easy access to your courses
 
 See [CONTRIBUTING.md](/CONTRIBUTING.md) for informations about how it works.
 
@@ -11,19 +10,19 @@ See [CONTRIBUTING.md](/CONTRIBUTING.md) for informations about how it works.
 For Arch Linux, there is the [epfl-moody-git](https://aur.archlinux.org/packages/epfl-moody-git/) AUR package.  
 Fedora and Debian packages are planned.
 
-### Flatpak ###
+### Flatpak Install ###
 
-(for it to work, you may need to [install flatpak](https://flatpak.org/setup/))
+*for it to work, you may need to [install flatpak](https://flatpak.org/setup/)*
 
 You can also install using flatpak, which should work for every Linux distribution
 ```sh
 flatpak-builder --install-deps-from=flatpak --install --user --force-clean _flatbuild ch.gnugen.Moody.json
 ```
-For some reason, you may need to install elfutils `sudo apt install elfutils`  
+To build, you may need to install elfutils `sudo apt install elfutils`  
 Flatpak will build libhandy and myhtml from their repository, and use libsoup and libsecret
 from the Gnome runtime.
 
-You can also install it system-wide by removing the `--user` flags.
+You can also install it system-wide by removing the `--user` flag.
 
 ## Build it Yourself ##
 
@@ -52,14 +51,11 @@ ninja -C build-dir install
 
 ### Cache ###
 
-There is a cache system, but it currently uses the build dir
-and must be activated either always or never at compile time
-(see `CACHING` in config.h.in). For now, this is a feature used
-(and usable) for development purpose only; and it doesn't work
-with files, yet.
+There is a cache system that works pretty well, reusing every file recent enough.
+The only thing keeping it from being perfect is that it can't cache-hit the index,
+so it is still worked upon in the dev branch.
 
-## Future Work ##
 
-There is a lot to do: making use of GLib's GTask, loading courses
-from cache intelligently, adding the ability to read files inside folders,
-read files from cache…
+### Folder Handling ###
+
+You can open folders and access files inside it, which is good.
-- 
GitLab