Minor action/readme fixups (#24)

Author: bleggett

.github/workflows/markdown-lint.yml

@@ -0,0 +1,45 @@
+name: Markdown Lint
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**/*.md'
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  markdownlint:
+    name: runner / markdownlint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden runner
+        uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          fetch-depth: 0
+          persist-credentials: true
+
+      - name: generate cultivator token
+        uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf # v2.2.1
+        id: generate-token
+        with:
+          app-id: "${{ secrets.EDERA_CULTIVATION_APP_ID }}"
+          private-key: "${{ secrets.EDERA_CULTIVATION_APP_PRIVATE_KEY }}"
+
+      - name: markdownlint
+        uses: step-security/action-markdownlint@d73340eb9977ec4bda276978f3239949cfa76e77
+        with:
+          GITHUB_TOKEN: "${{ steps.generate-token.outputs.token }}"
+          reporter: github-pr-review
+          level: warning
+          fail_level: error
+          markdownlint_flags: '--config .markdownlint.json .'
+        continue-on-error: false
+

.github/workflows/release.yaml

@@ -47,6 +47,7 @@ jobs:
           command: release
         env:
           GITHUB_TOKEN: "${{ steps.generate-token.outputs.token }}"
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 
   release-plz-pr:
     if: ${{ github.repository_owner == 'edera-dev' }}

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "MD013": false
+}

README.md

@@ -6,12 +6,11 @@ A CLI tool to validate your system is ready to install or use Edera, and generat
 
 ## Installation
 
-## Usage
-
 ### Install via Cargo
 
 ``` bash
 cargo install edera-check
+sudo edera-check --help
 ```
 
 ### Run official release via Docker
@@ -26,13 +25,7 @@ docker run \
 
 `podman` et al should also work.
 
-### Run locally from repo root via Docker
-
-Recommended way to run locally and debug/validate, will use local copy of repo.
-
-```bash
-sh hack/debug/local.sh
-```
+## Usage
 
 ### General usage
 
@@ -116,3 +109,11 @@ for a list of available configuration options and usage tweaks.
 * [src/helpers](src/helpers) - Shared bits.
 
 By default, everything runs inside the container, and any system tools or binaries or other bits needed by the checkers can be installed or baked inside the container. For checks that need to jump out and touch the host filesystem or state, we use the [src/helpers/host_executor.rs](src/helpers/host_executor.rs).
+
+### Run locally from repo root via Docker
+
+Recommended way to run locally and debug/validate, will use local copy of repo.
+
+```bash
+sh hack/debug/local.sh
+```