fix(docs): improve consistency

open-turo · Mar 21, 2022 · 3bd56cc · 3bd56cc
1 parent 9d4e0bf
commit 3bd56cc
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/lint/README.md b/lint/README.md
@@ -1,14 +1,14 @@
 # GitHub Action Lint
 
-GitHub Action that runs lint on a GitHub repository.
+GitHub Action that runs lint on a go based GitHub repository.
 
 ## Usage
 
 ```yaml
 jobs:
   build:
     steps:
-      - name: Action Lint
+      - name: Action lint
         uses: open-turo/actions-go/lint@v1
 ```
 

diff --git a/release/action.yaml b/release/action.yaml
@@ -6,7 +6,7 @@ inputs:
     description: "Perform checkout as first step of action"
     default: "true"
   github-token:
-    description: "Github token to use for authentication"
+    description: "GitHub token that can checkout the repository. e.g. 'secrets.GITHUB_TOKEN'"
     required: true
   go-version:
     description: "Go version to use for building"

diff --git a/test/README.md b/test/README.md
@@ -1,6 +1,6 @@
 # GitHub Action Test
 
-GitHub Action that runs unit tests present within the GitHub repository and report test coverage metrics.
+GitHub Action that runs unit tests present within a go based GitHub repository and report test coverage metrics.
 
 ## Usage