about summary refs log tree commit diff
path: root/README.org
diff options
context:
space:
mode:
authorGriffin Smith <root@gws.fyi>2020-03-19T19·30-0400
committerGriffin Smith <root@gws.fyi>2020-03-19T19·30-0400
commit750f0fd82d01a72ecb451888769e1813f13a2e0c (patch)
treea9a7d889de2a4d72e2f6070bec96498ad8c07d6b /README.org
parent9d792b8c6e2f46d35e8cec728e13f568a8f23094 (diff)
Add docs for org-clubhouse-username config value
This is crummy but it's how it has to be right now
Diffstat (limited to 'README.org')
-rw-r--r--README.org4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.org b/README.org
index 7a5f6d30d7d4..9cd8fbe8921d 100644
--- a/README.org
+++ b/README.org
@@ -50,6 +50,10 @@ Once installed, you'll need to set three global config vars:
 You can generate a new personal API token by going to the "API Tokens" tab on
 the "Settings" page in the clubhouse UI.
 
+Note that ~org-clubhouse-username~ needs to be set to your *mention name*, not
+your username, as currently there's no way to get the ID of a user given their
+username in the clubhouse API
+
 * Usage
 
 ** Reading from clubhouse