chore: add a mdlinter

.github/workflows/lint.yml

@@ -22,3 +22,8 @@ jobs:
         uses: docker://rhysd/actionlint:1.6.23
         with:
           args: -color
+
+  mdlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: DavidAnson/markdownlint-cli2-action@v11

.markdownlint-cli2.yaml

@@ -0,0 +1,2 @@
+globs:
+  - "**/*.md"

.markdownlint.yaml

@@ -0,0 +1,19 @@
+# For a list of all rules, see here:  https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
+
+# Default state for all rules
+default: true
+
+# MD013/line-length - Line length
+MD013: false
+
+# MD024/Multiple headings with the same content
+MD024: false
+
+# MD026/no-trailing-punctuation - Trailing punctuation in heading
+MD026: false
+
+# MD033/no-inline-html - Inline HTML
+MD033: false
+
+# MD037/Spaces inside emphasis markers
+MD037: false

README.md

@@ -1,26 +1,27 @@
-<div align="center">
+# asdf-gofumpt
 
-# asdf-gofumpt [![Build](https://github.com/looztra/asdf-gofumpt/actions/workflows/build.yml/badge.svg)](https://github.com/looztra/asdf-gofumpt/actions/workflows/build.yml) [![Lint](https://github.com/looztra/asdf-gofumpt/actions/workflows/lint.yml/badge.svg)](https://github.com/looztra/asdf-gofumpt/actions/workflows/lint.yml)
+[![Build](https://github.com/looztra/asdf-gofumpt/actions/workflows/build.yml/badge.svg)](https://github.com/looztra/asdf-gofumpt/actions/workflows/build.yml)
+[![Lint](https://github.com/looztra/asdf-gofumpt/actions/workflows/lint.yml/badge.svg)](https://github.com/looztra/asdf-gofumpt/actions/workflows/lint.yml)
 
 [gofumpt](https://github.com/mvdan/gofumpt) plugin for the [asdf version manager](https://asdf-vm.com).
 
 </div>
 
-# Contents
+## Contents
 
-- [Dependencies](#dependencies)
-- [Install](#install)
-- [Contributing](#contributing)
-- [License](#license)
+- [asdf-gofumpt](#asdf-gofumpt)
+  - [Contents](#contents)
+  - [Dependencies](#dependencies)
+  - [Install](#install)
+  - [Contributing](#contributing)
+  - [License](#license)
 
-# Dependencies
-
-**TODO: adapt this section**
+## Dependencies
 
 - `bash`, `curl`, `tar`: generic POSIX utilities.
-- `SOME_ENV_VAR`: set this environment variable in your shell config to load the correct version of tool x.
+- `GITUB_TOKEN` set this environment variable (must be a valid [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)) in your shell config to load the correct version of tool x.
 
-# Install
+## Install
 
 Plugin:
 
@@ -34,7 +35,7 @@ gofumpt:
 
 ```shell
 # Show all installable versions
-asdf list-all gofumpt
+asdf list all gofumpt
 
 # Install specific version
 asdf install gofumpt latest
@@ -49,12 +50,12 @@ gofumpt --version
 Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
 install & manage versions.
 
-# Contributing
+## Contributing
 
 Contributions of any kind welcome! See the [contributing guide](contributing.md).
 
 [Thanks goes to these contributors](https://github.com/looztra/asdf-gofumpt/graphs/contributors)!
 
-# License
+## License
 
 See [LICENSE](LICENSE) © [Christophe Furmaniak](https://github.com/looztra/)

contributing.md

@@ -5,7 +5,6 @@ Testing Locally:
 ```shell
 asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]
 
-# TODO: adapt this
 asdf plugin test gofumpt https://github.com/looztra/asdf-gofumpt.git "gofumpt --version"
 ```