Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_seclabels/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,66 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: Security Labels
+...
+
+Introduction
+============
+
+This module implements [XEP-0258: Security Labels in
+XMPP](http://xmpp.org/extensions/xep-0258.htmla).
+
+Configuration
+=============
+
+As with all modules, you enable it by adding it to the modules\_enabled
+list.
+
+        modules_enabled = {
+            ...
+            "seclabels";
+            ...
+        }
+
+These options exist:
+
+  Name                      Description             Default
+  ------------------------- ----------------------- -------------
+  security\_catalog\_name   Catalouge name          "Default"
+  security\_catalog\_desc   Catalouge description   "My labels"
+
+You can then add your labels in a table called security\_labels. They
+can be both orderd and unorderd, but ordered comes first.
+
+        security_labels = {
+            { -- This label will come first
+                name = "Public",
+                label = true, -- This is a label, but without the actual label.
+                default = true -- This is the default label.
+            },
+            {
+                name = "Private",
+                label = "PRIVATE",
+                color = "white",
+                bgcolor = "blue"
+            },
+            Sensitive = { -- A Sub-selector
+                SECRET = { -- The index is used as name
+                    label = true
+                },
+                TOPSECRET = { -- The order of this and the above is not guaranteed.
+                    color = "red",
+                    bgcolor = "black",
+                }
+            }
+        }
+
+Each label can have the following properties:
+
+  Name             Description                                               Default
+  ---------------- --------------------------------------------------------- ----------------------------------------------------------
+  name             The name of the label. Used for selector.                 Required.
+  label            The actual label, ie `<esssecuritylabel/>`                Required, can be boolean for a empty label, or a string.
+  display          The text shown as display marking.                        Defaults to the name
+  color, bgcolor   The fore- and background color of the display marking     None
+  default          Boolean, true for the default. Only one may be default.   false