Merge pull request #10 from Link-/lintTown

adding linter

Author: admiralAwkbar

.github/workflows/linter.yml

@@ -0,0 +1,52 @@
+---
+#################################
+#################################
+## Super Linter GitHub Actions ##
+#################################
+#################################
+name: Lint Code Base
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+    branches-ignore: [master, main]
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Lint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: github/super-linter@v4
+        env:
+          VALIDATE_ALL_CODEBASE: true
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,3 +1,5 @@
+# GH Token
+
 ```sh
 * _____ _   *_   _______ *  _      *  *    **   *
  / ____| |* | | |__   __|  | |  *       *         🦄  *
@@ -7,11 +9,15 @@
  \_____|_|  |_|    |_|\___/|_|\_\___|_| |_|   *
 ```
 
+<!-- markdownlint-disable -->
+
 > Create an installation access token for a GitHub app from your terminal
 
 [![ghtoken size](https://img.shields.io/github/size/link-/gh-token/ghtoken?style=flat-square)](ghtoken) [![License](https://img.shields.io/github/license/link-/gh-token?style=flat-square)](LICENSE) ![platforms supported](https://img.shields.io/static/v1?style=flat-square&label=platform&message=macos%20%7C%20linux)
+<!-- markdownlint-restore -->
 
-[Creates an installation access token](https://docs.github.com/en/rest/reference/apps#create-an-installation-access-token-for-an-app) that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire 1 hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token.
+[Creates an installation access token](https://docs.github.com/en/rest/reference/apps#create-an-installation-access-token-for-an-app) that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account.
+Installation tokens expire 1 hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token.
 
 You can use this access token to make pretty much any REST or GraphQL API call the app is authorized to make!
 
@@ -60,8 +66,8 @@ wget -O ghtoken \
 ### curl
 
 ```sh
-# Download a file, name it ghtoken following [L]ocation redirects, and 
-# automatically [C]ontinuing (resuming) a previous file transfer then 
+# Download a file, name it ghtoken following [L]ocation redirects, and
+# automatically [C]ontinuing (resuming) a previous file transfer then
 # do a checksum
 curl -o ghtoken \
      -O -L -C  - \
@@ -409,7 +415,7 @@ jobs:
 
 ## Troubleshoot
 
-#### I'm getting: `Something went awry creating the jwt` with `ghtoken generate`
+### I'm getting: `Something went awry creating the jwt` with `ghtoken generate`
 
 Make sure your `pem` file has the extension `.pem`. This is necessary for `jwt-cli` to be able to determine the type of key it's trying to parse.