docs: update with usage

Author: thekaveman

README.md

@@ -1,2 +1,83 @@
 # conventional-pre-commit
-A pre-commit hook that checks the commit message for Conventional Commit formatting
+
+A [`pre-commit`](https://pre-commit.com) hook to check commit messages for
+[Conventional Commit](https://conventionalcommits.org) formatting.
+
+## Usage
+
+Make sure `pre-commit` is [installed](https://pre-commit.com#install).
+
+Create a blank configuration file at the root of your repo, if needed:
+
+```console
+touch .pre-commit-config.yaml
+```
+
+Add a new repo entry to your configuration file:
+
+```yaml
+repos:
+
+# - repo: ...
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: <git sha or tag>
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+```
+
+Install the `pre-commit` script:
+
+```console
+pre-commit install --hook-type commit-msg
+```
+
+Make a (normal) commit :x::
+
+```console
+$ git commit -m "add a new feature"
+
+[INFO] Initializing environment for ....
+Conventional Commit......................................................Failed
+- hook id: conventional-pre-commit
+- duration: 0.07s
+- exit code: 1
+
+[Commit message] add a new feature
+
+Your commit message doesn't look like a Conventional Commit https://www.conventionalcommits.org/
+
+Conventional Commit messages start with one of the below types, followed by a colon, followed by the message:
+
+    build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test
+
+Example commit message adding a feature:
+
+    feat: add great new feature
+
+Example commit message fixing an issue:
+
+    fix: remove infinite loop
+
+Optionally, include a scope in parentheses after the type for more context:
+
+    fix(account): remove infinite loop
+```
+
+Make a (conventional) commit :heavy_check_mark::
+
+```console
+$ git commit -m "feat: add a new feature"
+
+[INFO] Initializing environment for ....
+Conventional Commit......................................................Passed
+- hook id: conventional-pre-commit
+- duration: 0.05s
+```
+
+## License
+
+[Apache 2.0](LICENSE)
+
+Inspired by matthorgan's [`pre-commit-conventional-commits`](https://github.com/matthorgan/pre-commit-conventional-commits).