update readme

atlassian · Feb 26, 2019 · 87ace9c · 87ace9c
1 parent af4968d
commit 87ace9c
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,18 +2,22 @@
 Extract issue key from string
 
 ## Usage
-
-TBD
-
+```
+action "Find in commit messages" {
+  uses = "atlassian/gajira-find-issue-key@master"
+  needs = ["Login"]
+  args = "--from=commits"
+}
+```
 ----
 ## Action Spec:
 
 ### Environment variables
 - None
 
 ### Arguments
-- None
-
+- `--from=commits` - Detect issue key in commit messages from event
+- `--from=branch` - Detect issue key in branch name
 ### Reads fields from config file at $HOME/jira/config.yml
 - None