about summary refs log tree commit diff
path: root/README.org
diff options
context:
space:
mode:
authorGriffin Smith <root@gws.fyi>2019-03-08T15·42-0500
committerGriffin Smith <root@gws.fyi>2019-03-08T15·42-0500
commit453e6dc36c65215f8227d395ee7529735577fe29 (patch)
tree20f92113708ef3a322cb01604758c923c1f2c142 /README.org
parent9b9254123942126e4f2ce40253e60f6847f96c5b (diff)
feat: Add org-clubhouse-claim
Add a standalone org-clubhouse-claim function for claiming the current
story without making any other updates
Diffstat (limited to 'README.org')
-rw-r--r--README.org10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.org b/README.org
index f312b02a74a0..423dfc21ae87 100644
--- a/README.org
+++ b/README.org
@@ -1,4 +1,4 @@
-* Org-Clubhouse
+#+TITLE: Org-Clubhouse
 
 Simple, unopinionated integration between Emacs's [[https://orgmode.org/][org-mode]] and the [[https://clubhouse.io/][Clubhouse]] issue tracker
 
@@ -34,11 +34,12 @@ Simple, unopinionated integration between Emacs's [[https://orgmode.org/][org-mo
 
 * Setup
 
-Once installed, you'll need to set two global config vars:
+Once installed, you'll need to set three global config vars:
 
 #+BEGIN_SRC emacs-lisp
 (setq org-clubhouse-auth-token "<your-token>"
-      org-clubhouse-team-name "<your-team-name>")
+      org-clubhouse-team-name "<your-team-name>"
+      org-clubhouse-username "<your-username>")
 #+END_SRC
 
 You can generate a new personal API token by going to the "API Tokens" tab on
@@ -79,6 +80,9 @@ org-clubhouse provides the following commands:
   Create org-mode headlines from a clubhouse query at the cursor's current
   position, prompting for the headline indentation level and clubhouse query
   text
+- ~org-clubhouse-claim~
+  Adds the user configured in ~org-clubhouse-username~ as the owner of the
+  clubhouse story associated with the headline at point
 
 * Configuration