aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 7 insertions, 6 deletions
diff --git a/README b/README
index c426488..16ce040 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-Ayatana System Indicator -- Session
+# Ayatana System Indicator -- Session
The -session Ayatana System Indicator is the the session menu indicator
for Unity7 and MATE (optionally for others). Its behavior and features
@@ -7,8 +7,7 @@ are listed at https://wiki.ayatana-indicators.org/AyatanaIndicatorSession
For instructions on building and running built-in tests, see the INSTALL file.
-Notes for Client Renderers
---------------------------
+## Notes for Client Renderers
Ayatana Indicator Session has two custom menuitems: the Guest and User
switchers. As per the
@@ -16,7 +15,8 @@ https://wiki.ayatana-indicators.org/AyatanaIndicatorSession
specification, both need four visual components: (1) an Active Session
Mark, the user's (2) icon, (3) name, and (4) a Logged In Mark.
-== User menuitems have "x-canonical-type" set to "indicator.user-menu-item"
+### User menuitems have "x-canonical-type" set to "indicator.user-menu-item"
+
Their four visual components are determined by:
1. You can test for the Action Session Mark by checking the action's state.
@@ -34,8 +34,9 @@ Mark, the user's (2) icon, (3) name, and (4) a Logged In Mark.
an array of usernames. If the array contains the username in this
menuitem's "target" attribute, show the Logged In Mark.
-== The Guest switcher has "x-canonical-type" set to "indicator.guest-menu-item"
- action. Its four visual components are determined by:
+### The Guest switcher has "x-canonical-type" set to "indicator.guest-menu-item" action
+
+ Its four visual components are determined by:
1. You can test for the Active Session Mark by checking the action's state.
The state is a dictionary whose "is-active" key yields a boolean.