From fcf36615e49f8f87f369840fce3234324750d917 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Sun, 20 Jan 2019 19:47:12 +0100
Subject: [PATCH] README: more text, but mostly place holders

---
 README.md | 116 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 114 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b5a4578..bf27585 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,124 @@
 
 [![pipeline status](https://gitlab.com/dnkl/f00bar/badges/master/pipeline.svg)](https://gitlab.com/dnkl/f00bar/commits/master)
 
-![screenshot](screenshot.png "Example configuration")
-
 
 ## Index
 
+1. [Introduction](#introduction)
+1. [Modules](#modules)
+  1. [Alsa](#alsa)
+  1. [backlight](#backlight)
+  1. [battery](#battery)
+  1. [clock](#clock)
+  1. [i3](#i3)
+  1. [label](#label)
+  1. [mpd](#mpd)
+  1. [network](#network)
+  1. [removables](#removables)
+  1. [xkb](#xkb)
+  1. [xwindow](#xwindow)
+1. [Particles](#particles)
+  1. [empty](#empty)
+  1. [list](#list)
+  1. [map](#map)
+  1. [progress  1.bar](#progress_bar)
+  1. [ramp](#ramp)
+  1. [string](#string)
+1. [Decorations](#decorations)
+  1. [background](#background)
+  1. [stack](#stack)
+  1. [underline](#underline)
 1. [Configuration](#configuration)
+  1. [Overview](#overview)
+  1. [Types](#types)
+  1. [Bar](#bar)
+
+
+## Introduction
+
+![screenshot](screenshot.png "Example configuration")
+
+**f00bar** is a light-weight and configurable status panel (_bar_, for
+short) for X.
+
+It has a number of _modules_ that provides information in the form of
+_tags_. For example, the _clock_ module has a _date_ tag that contains
+the current date.
+
+The modules do not know _how_ to present the information though. This
+is instead done by _particles_. And the user, you, decides _which_
+particles (and thus _how_ to present the data) to use.
+
+Furthermore, each particle can have a _decoration_. These are things
+like a different background, or an graphical underline.
+
+There is **no** support for images or icons. use an icon font
+(e.g. _Font Awesome_, or _Material Icons_) if you want a graphical
+representation.
+
+There are a number of modules and particles builtin. More can be added
+as plugins. You can even write your own!
+
+To summarize: a _bar_ displays information provided by _modules_,
+using _particles_ and _decorations_. **How** is configured by you.
+
+
+## Modules
+
+- [alsa](#alsa)
+- [backlight](#backlight)
+- [battery](#battery)
+- [clock](#clock)
+- [i3](#i3)
+- [label](#label)
+- [mpd](#mpd)
+- [network](#network)
+- [removables](#removables)
+- [xkb](#xkb)
+- [xwindow](#xwindow)
+
+
+### Alsa
+### Backlight
+### Battery
+### Clock
+### I3
+### Label
+### Mpd
+### Network
+### Removables
+### Xkb
+### Xwindow
+
+
+## Particles
+
+- [empty](#empty)
+- [list](#list)
+- [map](#map)
+- [progress-bar](#progress_bar)
+- [ramp](#ramp)
+- [string](#string)
+
+
+### Empty
+### List
+### Map
+### Progress-bar
+### Ramp
+### String
+
+
+## Decorations
+
+- [background](#background)
+- [stack](#stack)
+- [underline](#underline)
+
+
+### Background
+### Stack
+### Underline
 
 
 ## Configuration