Skip to content

Commit

Permalink
chore: updated documentation example
Browse files Browse the repository at this point in the history
  • Loading branch information
JaleelB committed May 22, 2024
1 parent 7db2c32 commit 244474d
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,24 @@ jira-flow init
### A Quick Example
Here's a glimpse of how Jira-Flow will work:
Heres a quick example of initializing Jira-Flow and configuring it to automatically detect JIRA issue keys:
```bash
# Running Jira-Flow for the first time in a repository
$ jira-flow init
# The interactive CLI will present the user with a menu:
1. Auto-detect JIRA issue key from branch name.
2. Manually enter the JIRA issue key.
# User selects option 1 and the tool configures the Git hook automatically.
# Welcome message and logo displayed
? How would you like to proceed:
▸ Configure Jira-Flow
Remove Jira-Flow
Exit Jira-Flow
# User selects 'Configure Jira-Flow'
? Choose configuration method:
▸ Automatically link commits to Jira issues based on branch name
Manually link commits to Jira issues by entering the Jira issue key
# User chooses 'Automatically'
# Success message confirming automatic linking
"Success! The JIRA issue key will now be prepended to your commits."
```
Expand Down

0 comments on commit 244474d

Please sign in to comment.