docs improvements

Author: vladopajic

.testcoverage.example.yml

@@ -1,5 +1,5 @@
 # (mandatory) 
-# Path to coverprofile file (output of `go test -coverprofile` command).
+# Path to coverage profile file (output of `go test -coverprofile` command).
 #
 # For cases where there are many coverage profiles, such as when running 
 # unit tests and integration tests separately, you can combine all those
@@ -8,21 +8,21 @@
 profile: cover.out
 
 # (optional; but recommended to set) 
-# When specified reported file paths will not contain local prefix in the output
+# When specified reported file paths will not contain local prefix in the output.
 local-prefix: "github.com/org/project"
 
-# Holds coverage thresholds percentages, values should be in range [0-100]
+# Holds coverage thresholds percentages, values should be in range [0-100].
 threshold:
   # (optional; default 0) 
-  # The minimum coverage that each file should have
+  # Minimum coverage percentage required for individual files.
   file: 70
 
   # (optional; default 0) 
-  # The minimum coverage that each package should have
+  # Minimum coverage percentage required for each package.
   package: 80
 
   # (optional; default 0) 
-  # The minimum total coverage project should have
+  # Minimum overall project coverage percentage required.
   total: 95
 
 # Holds regexp rules which will override thresholds for matched files or packages 
@@ -33,12 +33,12 @@ threshold:
 # override rules should be listed in order from specific to more general rules.
 override:
   # Increase coverage threshold to 100% for `foo` package 
-  # (default is 80, as configured above in this example)
+  # (default is 80, as configured above in this example).
   - threshold: 100
     path: ^pkg/lib/foo$
 
 # Holds regexp rules which will exclude matched files or packages 
-# from coverage statistics
+# from coverage statistics.
 exclude:
   # Exclude files or packages matching their paths
   paths:
@@ -47,4 +47,4 @@ exclude:
 
 # NOTES:
 # - symbol `/` in all path regexps will be replaced by current OS file path separator
-#   to properly work on Windows
+#   to properly work on Windows.

README.md

@@ -80,7 +80,7 @@ Here’s an example [.testcoverage.yml](./.testcoverage.example.yml) configurati
 
 ```yml
 # (mandatory) 
-# Path to coverprofile file (output of `go test -coverprofile` command).
+# Path to coverage profile file (output of `go test -coverprofile` command).
 #
 # For cases where there are many coverage profiles, such as when running 
 # unit tests and integration tests separately, you can combine all those
@@ -89,21 +89,21 @@ Here’s an example [.testcoverage.yml](./.testcoverage.example.yml) configurati
 profile: cover.out
 
 # (optional; but recommended to set) 
-# When specified reported file paths will not contain local prefix in the output
+# When specified reported file paths will not contain local prefix in the output.
 local-prefix: "github.com/org/project"
 
-# Holds coverage thresholds percentages, values should be in range [0-100]
+# Holds coverage thresholds percentages, values should be in range [0-100].
 threshold:
   # (optional; default 0) 
-  # The minimum coverage that each file should have
+  # Minimum coverage percentage required for individual files.
   file: 70
 
   # (optional; default 0) 
-  # The minimum coverage that each package should have
+  # Minimum coverage percentage required for each package.
   package: 80
 
   # (optional; default 0) 
-  # The minimum total coverage project should have
+  # Minimum overall project coverage percentage required.
   total: 95
 
 # Holds regexp rules which will override thresholds for matched files or packages 
@@ -114,12 +114,12 @@ threshold:
 # override rules should be listed in order from specific to more general rules.
 override:
   # Increase coverage threshold to 100% for `foo` package 
-  # (default is 80, as configured above in this example)
+  # (default is 80, as configured above in this example).
   - threshold: 100
     path: ^pkg/lib/foo$
 
 # Holds regexp rules which will exclude matched files or packages 
-# from coverage statistics
+# from coverage statistics.
 exclude:
   # Exclude files or packages matching their paths
   paths:
@@ -128,7 +128,7 @@ exclude:
 
 # NOTES:
 # - symbol `/` in all path regexps will be replaced by current OS file path separator
-#   to properly work on Windows
+#   to properly work on Windows.
 ```
 
 ### Exclude Code from Coverage

action.yml

@@ -1,104 +1,117 @@
 name: go-test-coverage
 author: vladopajic
-description: go-test-coverage is tool which reports issues when test coverage is below set threshold.
+description: go-test-coverage is a tool designed to report issues when test coverage falls below a specified threshold, ensuring higher code quality and preventing regressions in test coverage over time.
 inputs:
+  # Config
   config:
-    description: Path of configuration file.
+    description: Path to the configuration file (.testcoverage.yml), which defines test coverage settings and thresholds.
     required: false
     default: ""
     type: string
+  
+  # Individual properties
   profile:
-    description: Path of coverage profile file.
+    description: Path to the coverage profile file. Overrides value from configuration.
     required: false
     default: ""
     type: string
   local-prefix:
-    description: When specified reported file paths will not contain local prefix in the output.
+    description: When specified reported file paths will not contain local prefix in the output. Overrides value from configuration.
     required: false
     default: ""
     type: string
   threshold-file:
-    description: The minimum coverage that each file should have.
+    description: Minimum coverage percentage required for individual files. Overrides value from configuration.
     required: false
     default: -1
     type: number
   threshold-package:
-    description: The minimum coverage that each package should have.
+    description: Minimum coverage percentage required for each package. Overrides value from configuration.
     required: false
     default: -1
     type: number
   threshold-total:
-    description: The minimum total coverage project should have.
+    description: Minimum overall project coverage percentage required. Overrides value from configuration.
     required: false
     default: -1
     type: number
+
+  # Badge (as file)
   badge-file-name:
-    description: When specified coverage badge will be created and saved to this file.
+    description: If specified, a coverage badge will be generated and saved to the given file path.
     required: false
     default: ""
     type: string
+  
+  # Badge (on CDN)
   cdn-secret:
-    description: CDN API secret. When specified action will create and upload badge to CDN.
+    description: API secret key for CDN. If specified, the badge will be uploaded to the CDN.
     required: false
     default: ""
     type: string
   cdn-key:
-    description: CDN API key.
+    description: API key for CDN access.
     required: false
     default: ""
     type: string
   cdn-region:
-    description: CDN region.
+    description: Specifies the CDN region for the badge upload.
     required: false
     default: ""
     type: string
   cdn-endpoint:
-    description: CDN endpoint. 
+    description: URL endpoint for CDN where the badge will be uploaded.
     required: false
     default: ""
     type: string
   cdn-file-name:
-    description: File name (including path) of badge on CDN.
+    description: Filename (including path) for storing the badge on the CDN.
     required: false
     default: ""
     type: string
   cdn-bucket-name:
-    description: CDN bucket name.
+    description: Name of the CDN bucket where the badge will be saved.
     required: false
     default: ""
     type: string
   cdn-force-path-style:
-    description: CDN force path style.
+    description: Forces path-style URL access in the CDN.
     required: false
     default: false
     type: boolean
+  
+  # Badge (on Git)
   git-token:
-    description: GitHub token. When specified action will create and upload badge to GitHub repository.
+    description: GitHub token for authorization. If provided, the badge will be uploaded to the specified GitHub repository.
     required: false
     default: ""
     type: string
   git-repository:
-    description: GitHub repository in format {owner}/{repository} where badge is stored.
+    description: Target GitHub repository in {owner}/{repository} format where the badge will be stored.
     required: false
     default: ${{ github.repository }}
     type: string
   git-branch:
-    description: Branch where badge is stored.
+    description: Repository branch where the badge file will be saved.
     required: false
     default: ""
     type: string
   git-file-name:
-    description: File name (including path) of badge stored to specified repository.
+    description: File name (including path) for storing the badge in the specified repository.
     required: false
     default: .badges/${{ github.ref_name }}/coverage.svg
     type: string
+
 outputs:
   total-coverage:
-    description: Holds total coverage value.
-  badge-text:
-    description: Deprecated! Holds badge text value.
+    description: Integer value in the range [0-100], representing the overall project test coverage percentage.
   badge-color:
-    description: Deprecated! Holds badge color value.
+    description: Color hex code for the badge  (e.g., `#44cc11`), representing the coverage status. 
+  report:
+    description: JSON-encoded string containing the detailed test coverage report.
+  badge-text:
+    description: Deprecated! Text label for the badge.
+
 runs:
   using: docker
   image: docker://ghcr.io/vladopajic/go-test-coverage:v2.10.4
@@ -122,6 +135,7 @@ runs:
     - --git-branch=${{ inputs.git-branch || '''''' }}
     - --git-repository=${{ inputs.git-repository || ''''''}}
     - --git-file-name=${{ inputs.git-file-name || '''''' }}
+
 branding:
   icon: 'code'
   color: 'blue'

docs/github_action.md

@@ -33,11 +33,12 @@ The GitHub Action will set the following outputs, which can be used later in you
 
 | Name            | Description                  |
 |-----------------|------------------------------|
-|`total-coverage` | Integer value in the range [0-100], representing the total coverage percentage. |
-|`badge-color`    | String value holding the color hex code for the badge (e.g., `#44cc11`). |
-|`badge-text`     | The total-coverage value concatenated with a % (e.g., `100%`). |
-|`report`         | JSON-encoded string representing the coverage report from `go-test-coverage`. |
+|`total-coverage` | Integer value in the range [0-100], representing the overall project test coverage percentage. |
+|`badge-color`    | Color hex code for the badge  (e.g., `#44cc11`), representing the coverage status. |
+|`badge-text`     | Deprecated! Text label for the badge. |
+|`report`         | JSON-encoded string containing the detailed test coverage report. |
 
+Note: Action outputs and inputs are also documented in [action.yml](/action.yml) file.
 
 # Post Coverage Report to PR