Enhance help message and README (#5)

* feat: Add `bold_echo` function and enhance help message

* test: Update help message tests

* docs: Update README and Image path

Author: toshimaru

README.md

@@ -4,24 +4,42 @@
 
 Clean up your outdated GitHub Actions workflow logs.
 
-![OG Image](./img/og.png)
+![Cover Image](./img/cover.png)
 
 ## Usage
 
 ```console
 $ gh workflow-log-cleaner "Your Workflow Name (<workflow-id> or <workflow-name> or <filename>)"
 ```
 
+## Example
+
+```console
+$ gh workflow-log-cleaner test
+```
+
+```console
+$ gh workflow-log-cleaner test --limit 10
+```
+
 ## Don't know your workflow name?
 
 If you don't know your workflow name or workflow id, you can find it by running `gh workflow-log-cleaner` without any arguments.
 
 ```console
 $ gh workflow-log-cleaner
-Usage:
-gh workflow-log-cleaner [<workflow-id> | <workflow-name> | <filename>]
+USAGE
+gh workflow-log-cleaner [<workflow-id> | <workflow-name> | <filename>] [options]
+
+OPTIONS
+  -h, --help    Show this help message and exit
+  --limit int   Limit the number of runs to delete (default: 1000)
+
+EXAMPLES
+  Remove logs for the test workflow
+  $ gh workflow-log-cleaner test
 
-Available workflows:
+AVAILABLE WORKFLOWS
 NAME   STATE   ID
 setup  active  114854128
 test   active  114855097

gh-workflow-log-cleaner

@@ -7,15 +7,23 @@ export GH_PAGER=
 LIMIT="1000"
 WORKFLOW=""
 
+bold_echo() {
+  echo -e "\e[1m$1\e[0m"
+}
+
 help() {
-  echo "Usage:"
+  bold_echo "USAGE"
   echo "gh workflow-log-cleaner [<workflow-id> | <workflow-name> | <filename>] [options]"
   echo ""
-  echo "Options:"
-  echo "  -h, --help  Show this help message and exit"
-  echo "  --limit     Limit the number of runs to delete (default: 1000)"
+  bold_echo "OPTIONS"
+  echo "  -h, --help    Show this help message and exit"
+  echo "  --limit int   Limit the number of runs to delete (default: 1000)"
   echo ""
-  echo "Available workflows:"
+  bold_echo "EXAMPLES"
+  echo "  Remove logs for the test workflow"
+  echo "  $ gh workflow-log-cleaner test"
+  echo ""
+  bold_echo "AVAILABLE WORKFLOWS"
   gh workflow list --all
 }
 
@@ -47,9 +55,9 @@ while [ $# -gt 0 ]; do
 done
 
 if [ -z "$WORKFLOW" ]; then
-    echo "Error: Specify a workflow to delete the log."
-    help
-    exit 1
+  echo "Error: Specify a workflow to delete the log."
+  help
+  exit 1
 fi
 
 for id in $(gh run list --workflow "$WORKFLOW" --json databaseId --jq '.[].databaseId' --limit $LIMIT); do

gh-workflow-log-cleaner.bats

@@ -10,33 +10,17 @@ assert_output_contains() {
 @test "without parameter" {
   run ./gh-workflow-log-cleaner
   [ "$status" -eq 0 ]
-  expected_output="Usage:
-gh workflow-log-cleaner [<workflow-id> | <workflow-name> | <filename>] [options]
-
-Options:
-  -h, --help  Show this help message and exit
-  --limit     Limit the number of runs to delete (default: 1000)
-
-Available workflows:
-setup	active	114854128
-test	active	114855097"
-  [ "$output" = "$expected_output" ]
+  assert_output_contains 'gh workflow-log-cleaner [<workflow-id> | <workflow-name> | <filename>] [options]'
+  assert_output_contains 'setup	active	114854128
+test	active	114855097'
 }
 
 @test "with help option" {
   run ./gh-workflow-log-cleaner --help
   [ "$status" -eq 0 ]
-  expected_output="Usage:
-gh workflow-log-cleaner [<workflow-id> | <workflow-name> | <filename>] [options]
-
-Options:
-  -h, --help  Show this help message and exit
-  --limit     Limit the number of runs to delete (default: 1000)
-
-Available workflows:
-setup	active	114854128
-test	active	114855097"
-  [ "$output" = "$expected_output" ]
+  assert_output_contains 'gh workflow-log-cleaner [<workflow-id> | <workflow-name> | <filename>] [options]'
+  assert_output_contains 'setup	active	114854128
+test	active	114855097'
 }
 
 @test "with a workflow-name and limit option" {