From b99e3d8ea2a55609638ca54d81f2a8626528a38e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Mon, 21 Jan 2019 19:58:17 +0100
Subject: [PATCH] README: document the alsa module

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0a8d6f6..84ddf00 100644
--- a/README.md
+++ b/README.md
@@ -135,7 +135,6 @@ The value of each item in the `left`, `center` and `right` lists is a _module_.
 - [xwindow](#xwindow)
 
 
-### Alsae
 ### Generic Configuration
 
 **All** modules support the following attributes:
@@ -146,6 +145,34 @@ The value of each item in the `left`, `center` and `right` lists is a _module_.
 | anchors | dict     | Free-to-use dictionary, where you can put yaml anchor definitions
 
 
+### Alsa
+
+Monitors an alsa soundcard for volume and mute/unmute changes.
+
+#### Tags
+
+| Name   | Type  | Description
+|--------|-------|------------
+| volume | range | Volume level, with min and max as start and end range values
+| muted  | bool  | True if muted
+
+
+#### Configuration
+
+| Name          | Type   | Req. | Description
+|---------------|--------|------|------------
+| card          | string | yes  | The soundcard name. _Default_ might work.
+| mixer         | String | yes  | Mixer channel to watch. _Master_ might work.
+
+
+#### Example
+
+alsa:
+  card: hw:PCH
+  mixer: Master
+  content: {string: {text: "{volume}"}}
+
+
 ### Backlight
 ### Battery
 ### Clock