Skip to content

Commit d045209

Browse files
committed
Add installation instructions
1 parent bf3c9db commit d045209

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@
55

66
A CLI and Go library for GitHub's [CODEOWNERS file](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax).
77

8+
## Installation
9+
10+
Install the CLI from the [homebrew tap](https://github.com/hmarr/homebrew-tap#codeowners).
11+
12+
```console
13+
$ brew tap hmarr/tap
14+
$ brew install codeowners
15+
```
16+
17+
Install the library with `go get`.
18+
19+
```console
20+
$ go get github.com/hmarr/codeowners@latest
21+
```
22+
823
## Command line usage
924

1025
By default, the command line tool will walk the directory tree, printing the code owners of any files that are found.
@@ -50,6 +65,8 @@ example.go @example/go-engineers
5065

5166
## Go library usage
5267

68+
Documentation is available at [pkg.go.dev](https://pkg.go.dev/github.com/hmarr/codeowners).
69+
5370
```go
5471
package main
5572

0 commit comments

Comments
 (0)