From 87ace9cd0164b7079e5a0d1927865c0a0da9dd4c Mon Sep 17 00:00:00 2001
From: Dmytro Rudzik <drudzik@atlassian.com>
Date: Tue, 26 Feb 2019 19:03:11 +0200
Subject: [PATCH] update readme

---
 README.md | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index c5247277..1b48f0a5 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,13 @@
 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:
 
@@ -12,8 +16,8 @@ TBD
 - 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