README.md in danger-jira_issue_links-0.1.0 vs README.md in danger-jira_issue_links-0.1.1
- old
+ new
@@ -1,23 +1,32 @@
# danger-jira_issue_links
+### Plugin for [Danger](https://danger.systems/)
-Collect issue mentions from git commit messages and obtain info from Jira issue tracker.<br>
-Commit message should starts with pattern `[TASK-123]`, where TASK is id of jira project, 123 is issue number. For example commit message:
+This plugin collects issue mentions from git commit messages and obtains info from Jira issue tracker.<br>
+Commit message should start with pattern `[TASK-123]`, where TASK is Jira project Id and 123 is issue number. For example, for commit message:
```
[JSGLK-1145] Resolve bug with incorrect price calculation
```
Results are passed out as a table in the Danger comment for merge request.
![Screenshot](resources/danger-screenshot.png)
## Installation
+If you use Bundler, add next line to `Gemfile` and execute `bundle install`
+
+ gem 'danger-jira_issue_links'
+
+Or install manually
+
$ gem install danger-jira_issue_links
## Usage
+In `Dangerfile` add next lines:
+
Configure connection to you Jira instance
```
jira_issue_links.jira_username = "email"
jira_issue_links.jira_password = "password"
@@ -28,10 +37,10 @@
```
jira_issue_links.print_links_with_titles
```
Find all issue mentions in commit messages and make links. <br>
-No required access to Jira, needs only base url - `jira_site`.
+Not required access to Jira, needs only base url - `jira_site`.
```
jira_issue_links.print_links_only
```