README.md in jira_report-0.1.3 vs README.md in jira_report-0.1.4

- old
+ new

@@ -7,20 +7,20 @@ $ gem install jira_report ``` ##Usage -Just run it. `jira-report` will ask you your jira location, who you are and what's your password: +Just run it. `jira-report` will ask your jira site address, who you are and what's your password: ``` $ jira-report -Jira url: jira.company.com -Jira username: admin -Jira password: -Querying jira... +Jira site address: https://jira.company.com +Username for 'https://jira.company.com': admin +Password for 'https://jira.company.com': +Connecting to 'https://jira.company.com'. Pls wait... -Jira activity report for [admin]: +What was [admin] doing: Created: 2 WFM-7180 - Provide static context for log property in BasicHashAnalyzer TST-5862 - Unable to install Nginx on HP-UX with Java 6 @@ -44,11 +44,11 @@ GSM-364 - Migration of existing units ``` `url`, `username`, `password` and some other parameters can be added to [configuration file](#configuration). Also you can use mixed approach (keep some options in file, others enter from command line). For example if you do not want to keep password in configuration file, just don't, you will be asked. -Also you can use it directly in ruby: +Also you can use it directly in ruby code: ```ruby require 'jira_report' def print_issues(issues) @@ -80,10 +80,10 @@ url=jira.company.com username=username password=s3cr3t ``` -all those are optional and if not specified user will be asked to enter it from command line. +You may pass all those options (or some of them) in command line mode. Period is set by two options `period_from` and `period_till`. Both options support [advanced jira searching](https://confluence.atlassian.com/display/JIRA/Advanced+Searching) and accept dates, jira functions, aliasing. For example: ``` period_from=-1w