build: use linkinator to scan own README (#205)

Author: JustinBeckwith

.github/workflows/ci.yaml

@@ -36,6 +36,15 @@ jobs:
           node-version: 12
       - run: npm install
       - run: npm run lint
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm install
+      - run: npm run docs-test
   coverage:
     runs-on: ubuntu-latest
     steps:

package.json

@@ -17,7 +17,8 @@
     "fix": "gts fix",
     "codecov": "c8 report --reporter=json && codecov -f coverage/*.json",
     "lint": "gts lint",
-    "build-binaries": "pkg . --out-path build/binaries"
+    "build-binaries": "pkg . --out-path build/binaries",
+    "docs-test": "npm link && linkinator ./README.md"
   },
   "dependencies": {
     "chalk": "^4.0.0",