feat(cli): add documentation link

hyiso · Jan 20, 2023 · 305bb99 · 305bb99
1 parent eb39d61
commit 305bb99
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/packages/commitlint_cli/README.md b/packages/commitlint_cli/README.md
@@ -6,7 +6,8 @@ commitlint cli lint commit messages to satisfy [conventional commit format](http
 
 With [husky](https://pub.dev/packages/husky) (a tool for managing git hooks), commitlint cli can be used as commmit-msg git hook
 
-# Install
+
+# Usage
 
 Add `commitlint_cli` and [husky](https://pub.dev/packages/husky) to your `dev_dependencies` in pubspec.yaml
 
@@ -16,7 +17,7 @@ dev_dependencies:
   husky: latest
 ```
 
-# Usage
+Get dependencies and install husky
 
 ```sh
 dart pub get
@@ -34,7 +35,7 @@ Make a commit:
 ```sh
 git add .
 git commit -m "Keep calm and commit"
-# `ddart run commitlint_cli --edit "$1"` will run
+# `dart run commitlint_cli --edit "$1"` will run
 ```
 
 # Documentation

diff --git a/packages/commitlint_cli/pubspec.yaml b/packages/commitlint_cli/pubspec.yaml
@@ -5,6 +5,7 @@ description:
 version: 0.2.0
 homepage: https://github.com/hyiso/commitlint
 repository: https://github.com/hyiso/commitlint/packages/commitlint_cli
+documentation: https://hyiso.github.io/commitlint
 
 environment:
   sdk: '>=2.12.0 <3.0.0'