diff options
| -rw-r--r-- | README.org | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/README.org b/README.org index be3423598e93..0300381ba02c 100644 --- a/README.org +++ b/README.org @@ -50,14 +50,6 @@ 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. -Org-clubhouse can be configured to update the status of stories as you update -their todo-keyword in org-mode. To opt-into this behavior, set the -~org-clubhouse-mode~ minor-mode: - -#+BEGIN_SRC emacs-lisp -(add-hook 'org-mode-hook #'org-clubhouse-mode nil nil) -#+END_SRC - * Usage ** Reading from clubhouse @@ -97,6 +89,32 @@ their todo-keyword in org-mode. To opt-into this behavior, set the Adds the user configured in ~org-clubhouse-username~ as the owner of the clubhouse story associated with the headline at point +*** Automatically updating Clubhouse story statuses + +Org-clubhouse can be configured to update the status of stories as you update +their todo-keyword in org-mode. To opt-into this behavior, set the +~org-clubhouse-mode~ minor-mode: + +#+BEGIN_SRC emacs-lisp +(add-hook 'org-mode-hook #'org-clubhouse-mode nil nil) +#+END_SRC + +The mapping from org-mode todo-keywords is configured via the +~org-clubhouse-state-alist~ variable, which should be an [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Association-Lists.html][alist]] mapping (string) +[[https://orgmode.org/manual/Workflow-states.html][org-mode todo-keywords]] to the (string) names of their corresponding workflow +state. You can have todo-keywords that don't map to a workflow state (I use this +in my workflow extensively) and org-clubhouse will just preserve the previous +state of the story when moving to that state. + +An example config: + +#+BEGIN_SRC emacs-lisp +(setq org-clubhouse-state-alist + '(("TODO" . "To Do") + ("ACTIVE" . "In Progress") + ("DONE" . "Done"))) +#+END_SRC + * Philosophy I use org-mode every single day to manage tasks, notes, literate programming, |