diff --git a/README.md b/README.md index bec650f3..7066333d 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,13 @@ Some of the policies included are: ## Getting Started -Create a file named `.conform.yaml` with the following contents: +To install conform you can download a [release](https://github.com/talos-systems/conform/releases), or build it locally (go must be installed): + +```bash +go get github.com/talos-systems/conform +``` + +Now, create a file named `.conform.yaml` with the following contents: ```yaml policies: @@ -74,6 +80,17 @@ commit Commit Body PASS license File Header PASS ``` +To setup a `commit-msg` hook: + +```bash +cat <