diff --git a/README.md b/README.md index a1f1187..f0dc5ca 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # Jig -(Ji)ra (G)it
-Most if not all my work at $day_job is coordinated through and logged in Jira.
+(Ji)ra (G)it +Most if not all my work at $day_job is coordinated through and logged in Jira. additionally I'm not a fan of doing simple tasks in the Jira UI.. -I looked at existing Jira CLI tools, but none solve my exact use case.
+I looked at existing Jira CLI tools, but none solve my exact use case. Hence, [Jig](https://www.youtube.com/watch?v=3JcmQONgXJM)! -Jig is opinionated towards working with a healthy "Per issue" branching model, also known as "My workflow".
+Jig is opinionated towards working with a healthy "Per issue" branching model, also known as "My workflow". It therefore includes options and features I need to support that. -Primarily:
-Creating new branches from Jira issues with(out) summaries.
-Quickly logging time and Commenting on the issue found in the branch name.
-Moving issues from one status to the next. +Primarily: +Creating new branches from Jira issues with(out) summaries. +Quickly logging time and Commenting on the issue found in the branch name. +Moving issues from one status to the next. ## Installation @@ -30,7 +30,7 @@ add `--features fuzzy` to enable `fuzzy` selections (Will also enable `cloud` on ## Configuration -Supports global and local repository config files.
+Supports global and local repository config files. If both exist, they are merged with the local taking priority. See [example_config.toml](./example_config.toml) @@ -42,45 +42,48 @@ jig init [--all] ## Usage +[![asciicast](https://asciinema.org/a/604710.png)](https://asciinema.org/a/604710) + ```bash -jig --help -jig --help -# A Jira CLI integration with Git -# -# Usage: jig -# jig -# -# Commands: -# branch Create and checkout branch using issue key with(out) summary as branch name -# comment Create comment on a Jira Issue -# configs List config file locations -# init Initialise config file(s) -# log Create a work log entry on a Jira issue -# move Move ticket through transitions -# open Open issue using BROWSER var -# help Print this message or the help of the given subcommand(s) -# -# Options: -# -h, --help Print help -# -V, --version Print version +$ jig help + +A Jira CLI integration with Git + +Usage: jig + jig + +Commands: + branch Create and checkout branch using issue key with(out) summary as branch name + comment Create comment on a Jira Issue + configs List config file locations + init Initialise config file(s) + log Create a work log entry on a Jira issue + move Move ticket through transitions + open Open issue using BROWSER var + upgrade Download and install latest version (Cloud only) + help Print this message or the help of the given subcommand(s) + +Options: + -h, --help Print help + -V, --version Print version ``` Initialise a workspace or global config file: ```bash jig init -# --all to override defaults. +# --all to alter default behaviour ``` -The workspace config file (`.jig.toml`) will be created at the root of the repository or if not found, in the current directory. +The workspace config file (`.jig.toml`) will be created at the root of the current repository or if not found, in the current directory. The global file is created according to [XDG Conventions](https://docs.rs/etcetera/latest/etcetera/#conventions) -Be on or create a branch with an issue key in the name.
+Be on or create a branch with an issue key in the name. ```bash jig branch ``` Work on that branch and commit as normal. -Log work/Comment progress as you work normally.
+Log work/Comment progress as you work normally. ```bash # Optionally comment progress as you work. jig comment "Note: Changed impl due to X"