Minor updates

Author: cunla

README.md

@@ -4,11 +4,71 @@ GitHub Actions CLI
 The purpose of this tool is to work with your GitHub Actions workflows in your repositories.
 It is complementary to the GitHub CLI.
 
-It is important `GITHUB_TOKEN` environment variable is set in order for it to work properly.
+# Basic usage
 
-So far, three main flows are supported:
+Run `github-actions-cli` within a directory which has a clone of a GitHub repository.
+The tool will list the GitHub actions workflows, the actions they use, the current versions they use, and the latest
+versions of the actions.
 
-# List all workflows path and name in a specified repository.
+```text
+./.github/workflows/test.yml:
+	actions/checkout                  v3 ==> v3.5.3
+	release-drafter/release-drafter    v5 ==> v5.24.0
+	actions/setup-python              v4 ==> v4.7.0
+./.github/workflows/publish.yml:
+	pypa/gh-action-pypi-publish    release/v1 ==> v1.8.8
+	actions/checkout                  v3 ==> v3.5.3
+	actions/setup-python              v4 ==> v4.7.0
+```
+
+# Supported use cases
+
+```text
+Usage: github-actions-cli [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  -repo TEXT           Repository to analyze, can be a local directory or a
+                       {OWNER}/{REPO} format  [default: .]
+  --github-token TEXT  GitHub token to use, by default will use GITHUB_TOKEN
+                       environment variable
+  --help               Show this message and exit.
+
+Commands:
+  list-actions    List actions in a workflow
+  list-workflows  List workflows in repository
+  update-actions  Show actions required updates in repository workflows
+```
+
+## `update-actions` List all actions that are out of date in a repository (Default)
+
+List the latest versions of actions used in a repository workflows
+and potentially update the workflow files.
+
+For example, running `github-actions-cli` without any parameters will look for workflows in the
+current directory (`.`), check whether there are updates required for the actions in the workflows
+it finds.
+
+Another example, running on a remote repository, `github-actions-cli -repo cunla/fakeredis update-actions -u`,
+will look for the latest versions of the actions used in the repository cunla/fakeredis, and because of the `-u`
+flag, it will create a commit updating the workflows to the latest.
+
+> Note:
+> Having `GITHUB_TOKEN` with permissions to make commits on the repository
+> is required in order to write to repository.
+
+Parameters:
+
+```text
+Usage: cli.py update-actions [OPTIONS]
+
+  Show actions required updates in repository workflows
+
+Options:
+  -u, --update      Do not update, list only
+  -commit-msg TEXT  Commit msg, only relevant when remote repo
+```
+
+## `list-workflows` List all workflows path and name in a specified repository.
 
 Example:
 
@@ -23,68 +83,27 @@ will return:
 .github/workflows/test.yml
 ```
 
-# List all actions `uses` in a workflow
+## `list-actions` List all actions `uses` in a workflow
 
 Given a repo and a workflow path, return all actions in the workflow.
 
 Example:
+
 ```shell
 github-actions-cli -repo cunla/fakeredis list-actions .github/workflows/test.yml
 ```
 
 Result
+
 ```text
 actions/checkout@v3
 ./.github/actions/test-coverage
 release-drafter/release-drafter@v5
 actions/setup-python@v4
 ```
 
-# Update all actions in a repository workflows
-List the latest versions of actions used in a repository workflow and update the workflow files.
-
-Example for local clone of repository:
-```shell
-github-actions-cli update-actions --dry-run
-```
-
-or for remote repository without cloning:
-
-```shell
-github-actions-cli -repo cunla/fakeredis update-actions --dry-run
-```
-
-Result:
-```text
-./.github/workflows/test.yml:
-	release-drafter/release-drafter    v5 ==> v5.24.0
-	actions/checkout                  v3 ==> v3.5.3
-	actions/setup-python              v4 ==> v4.7.0
-./.github/workflows/publish.yml:
-	pypa/gh-action-pypi-publish    release/v1 ==> v1.8.8
-	actions/checkout                  v3 ==> v3.5.3
-	actions/setup-python              v4 ==> v4.7.0
-```
-
 # Installation
 
 ```shell
 pip install github-actions-cli
 ```
-
-# Help messages
-
-```text
-Usage: github-actions-cli [OPTIONS] COMMAND [ARGS]...
-
-Options:
-  -repo TEXT           Repository to analyze
-  --github-token TEXT  GitHub token to use, by default will use GITHUB_TOKEN
-                       environment variable
-  --help               Show this message and exit.
-
-Commands:
-  list-actions    List actions in a workflow
-  list-workflows  List workflows in repository
-  update-actions  List actions in a workflow
-```

gha_cli/cli.py

@@ -149,9 +149,12 @@ def _update_workflow_content(
 
 
 @click.group(invoke_without_command=True)
-@click.option('-repo', default='.', help='Repository to analyze')
-@click.option('--github-token', default=os.getenv('GITHUB_TOKEN'),
-              help='GitHub token to use, by default will use GITHUB_TOKEN environment variable')
+@click.option(
+    '-repo', default='.', show_default=True, type=str,
+    help='Repository to analyze, can be a local directory or a {OWNER}/{REPO} format')
+@click.option(
+    '--github-token', default=os.getenv('GITHUB_TOKEN'), type=str, show_default=False,
+    help='GitHub token to use, by default will use GITHUB_TOKEN environment variable')
 @click.pass_context
 def cli(ctx, repo: str, github_token: Optional[str]):
     ctx.ensure_object(dict)