1 files changed, 39 insertions, 0 deletions
diff --git a/desktop/yambar/README b/desktop/yambar/README
new file mode 100644
index 0000000000..2f456304d7
--- /dev/null
+++ b/desktop/yambar/README
@@ -0,0 +1,39 @@
+Yambar is a lightweight and configurable status panel (bar, for short)
+for X11 and Wayland, that goes to great lengths to be both CPU and 
+battery efficient - polling is only done when absolutely necessary.
+It has a number of modules that provide 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 - a background color or
+a graphical underline, for example.
+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.
+Yambar is configured using YAML, in ~/.config/yambar/config.yml
+For details, see the man pages yambar(5) is a good start.i
+
+Available modules:
+
+•alsa
+•backlight
+•battery
+•clock
+•i3 (and Sway)
+•label
+•mpd
+•network
+•removables
+•river
+•script 
+•sway-xkb
+•xkb (XCB backend only)
+•xwindow (XCB backend only)
+
+If you need to rebuild the package delete /tmp/SBo/yambar directory.