chore(readme): added instructions

Author: webdeveric

readme.md

@@ -1,13 +1,36 @@
-# `dual-ts-package-template`
+# `commitlint-plugin-cspell`
 
-[![Node.js CI](https://github.com/webdeveric/dual-ts-package-template/actions/workflows/node.js.yml/badge.svg)](https://github.com/webdeveric/dual-ts-package-template/actions/workflows/node.js.yml)
+[![Node.js CI](https://github.com/webdeveric/commitlint-plugin-cspell/actions/workflows/node.js.yml/badge.svg)](https://github.com/webdeveric/commitlint-plugin-cspell/actions/workflows/node.js.yml)
 
-## Usage
+## Install
 
-Click the "Use this template" button on this page and select "Create a new repository."
+```sh
+pnpm add commitlint-plugin-cspell -D
+```
 
-### GitHub CLI
+## Configure rules
 
-Reference: https://cli.github.com/manual/gh_repo_create
+This config shows all the rules provided by this plugin. You must use at least one of them to get spell checking.
 
-`gh repo create [YOUR-REPO-NAME] --template webdeveric/dual-ts-package-template --private`
+:information_source: If you're using conventional commits, you'll probably want to use `cspell/type`, `cspell/scope`, and `cspell/subject` instead of `cspell/header`.
+
+---
+
+Example `commitlint.config.mjs`:
+
+```js
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+export default {
+  plugins: ['commitlint-plugin-cspell'],
+  rules: {
+    'cspell/type': [2, 'always'],
+    'cspell/scope': [2, 'always'],
+    'cspell/subject': [2, 'always'],
+    'cspell/header': [2, 'always'],
+    'cspell/body': [2, 'always'],
+    'cspell/footer': [2, 'always'],
+  },
+};
+```