From c27cd920a81b9214c9dd356eefd292fb8cf3a938 Mon Sep 17 00:00:00 2001
From: Denis Lehmann <denis@opaque.tech>
Date: Tue, 14 Apr 2020 23:02:28 +0200
Subject: [PATCH] fill README

---
 README.md | 44 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7b4c7bf..fa36c10 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,44 @@
-# paperrs
+# spiderss
 
+![spiderss logo](images/logo.png)
+
+__spiderss__ is a plaintext RSS reader / crawler.
+Feeds are parsed the articles are stored as Markdown files on the filesystem.
+
+## Why?
+
+Because plaintext is God.
+
+## How can I read the articles?
+
+Use your favourite Markdown viewer, or just the console.
+__spiderss__ integrates nice with the [ranger](https://github.com/ranger/ranger) filemanager to browse categories.
+
+## How does it work?
+
+Edit the `config.toml` file to your liking and run the script.
+The script creates a folder structure the following way:
+
+```
+base_directory
+| - category
+    | - feedname
+        | - new
+        | - read
+    | - another feedname
+        | - new
+        | - read
+| - another category
+    | - a third feedname
+        | - new
+        | - read
+| - loved
+
+Every feed gets a `new` and a `read` subfolder.
+Article files are stored in the `new` folder.
+Move them to the `read` folder if you're done reading them.
+You can do this easily e.g. by setting a keybinding in ranger.
+
+A special folder, called `loved`, is created on startup.
+It is intended for articles, you want to keep.
+Articles inside are never deleted, even if they expire the _max_age_.