From 935b0f07e470c7849f5fd0b6e3180304f6d8bc9b Mon Sep 17 00:00:00 2001 From: Natan Yellin Date: Fri, 21 Jun 2024 05:24:56 +0300 Subject: [PATCH] Readme fixes (#54) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e7551fd1..a5fc8322 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Note - if on Mac OS and using the Docker image, you will need to use `http://doc holmes investigate jira --jira-url https://.atlassian.net --jira-username --jira-api-key ``` -By default Jira investigation results are displayed in the CLI itself. But you can use `--update-ticket` to get the results as a comment in the Jira ticket. +By default results are displayed in the CLI . Use `--update` to get the results as a comment in the Jira ticket. @@ -60,7 +60,7 @@ By default Jira investigation results are displayed in the CLI itself. But you c holmes investigate github --github-url https:// --github-owner --github-repository --github-pat ``` -By default GitHub investigation results are displayed in the CLI itself. But you can use `--update-issue` to get the results as a comment in the GitHub issue. +By default results are displayed in the CLI. Use `--update` to get the results as a comment in the GitHub issue. @@ -72,7 +72,7 @@ By default GitHub investigation results are displayed in the CLI itself. But you holmes investigate opsgenie --opsgenie-api-key ``` -By default OpsGenie investigation results are displayed in the CLI itself. But you can use `--update --opsgenie-team-integration-key ` to get the results as a comment in the OpsGenie alerts. Refer to the CLI help for more info. +By default results are displayed in the CLI . Use `--update --opsgenie-team-integration-key ` to get the results as a comment in the OpsGenie alerts. Refer to the CLI help for more info. ![OpsGenie](./images/opsgenie-holmes-update.png) @@ -85,7 +85,7 @@ By default OpsGenie investigation results are displayed in the CLI itself. But y holmes investigate pagerduty --pagerduty-api-key ``` -By default PagerDuty investigation results are displayed in the CLI itself. But you can use `--update --pagerduty-user-email ` to get the results as a comment in the PagerDuty issue. Refer to the CLI help for more info. +By default results are displayed in the CLI. Use `--update --pagerduty-user-email ` to get the results as a comment in the PagerDuty issue. Refer to the CLI help for more info. ![PagerDuty](./images/pagerduty-holmes-update.png)