Skip to content

Commit

Permalink
docs: add installation guide to README
Browse files Browse the repository at this point in the history
This adds missing documentation on how to install and use conform.

Signed-off-by: Andrew Rynhard <[email protected]>
  • Loading branch information
andrewrynhard committed Jan 8, 2020
1 parent 4eb4beb commit 01f87b9
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -74,6 +80,17 @@ commit Commit Body PASS <none>
license File Header PASS <none>
```

To setup a `commit-msg` hook:

```bash
cat <<EOF | tee .git/hooks/commit-msg
#!/bin/sh
conform enforce --commit-msg-file \$1
EOF
chmod +x .git/hooks/commit-msg
```

### License

[![license](https://img.shields.io/github/license/talos-systems/conform.svg?style=flat-square)](https://github.com/talos-systems/conform/blob/master/LICENSE)

0 comments on commit 01f87b9

Please sign in to comment.