diff --git a/README.md b/README.md index 7cd60b4..67c397c 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![version](https://img.shields.io/npm/v/prepare-commit-msg-angular.svg?style=flat-square)](http://npm.im/prepare-commit-msg-angular) [![MIT License](https://img.shields.io/npm/l/prepare-commit-msg-angular.svg?style=flat-square)](http://opensource.org/licenses/MIT) +## Basic Usage This provides you a binary that you can use as a githook to prepare a commit message following Angular guidelines and display documentation about it. To be used in addition to [validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg). @@ -22,3 +23,17 @@ To be used in addition to [validate-commit-msg](https://github.com/kentcdodds/va } } ``` + +## Message Template +By default, the `default.tpl` will be shown in your git editor. + +You can also specify your preferred message template by `-t` option. + +e.g. +``` + "config": { + "ghooks": { + "prepare-commit-msg": "prepare-commit-msg-angular $2 $3 -t tpl_file_path" + } + } +``` diff --git a/default.tpl b/default.tpl new file mode 100644 index 0000000..aad52f1 --- /dev/null +++ b/default.tpl @@ -0,0 +1,25 @@ +# (): +# +# +# +#