Skip to content

Commit 6ae5d49

Browse files
committed
Update README
1 parent 852773f commit 6ae5d49

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,26 @@
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
8+
## Command line tool
99

10-
Install the CLI from the [homebrew tap](https://github.com/hmarr/homebrew-tap#codeowners).
10+
The `codeowners` CLI identifies the owners for files in a local repository or directory.e
11+
12+
### Installation
13+
14+
If you're on macOS, you can install the CLI from the [homebrew tap](https://github.com/hmarr/homebrew-tap#codeowners).
1115

1216
```console
1317
$ brew tap hmarr/tap
1418
$ brew install codeowners
1519
```
1620

17-
Install the library with `go install`.
21+
Otherwise, grab a binary from the [releases page](https://github.com/hmarr/codeowners/releases) or install from source with `go install`:
1822

1923
```console
2024
$ go install github.com/hmarr/codeowners/cmd/codeowners@latest
2125
```
2226

23-
## Command line usage
27+
### Usage
2428

2529
By default, the command line tool will walk the directory tree, printing the code owners of any files that are found.
2630

@@ -71,9 +75,21 @@ $ codeowners -u
7175
CODEOWNERS (unowned)
7276
```
7377

74-
## Go library usage
78+
## Go library
79+
80+
A package for parsing CODEOWNERS files and matching files to owners.
81+
82+
### Installation
83+
84+
```console
85+
$ go get github.com/hmarr/codeowners
86+
```
87+
88+
### Usage
89+
90+
Full documentation is available at [pkg.go.dev](https://pkg.go.dev/github.com/hmarr/codeowners).
7591

76-
Documentation is available at [pkg.go.dev](https://pkg.go.dev/github.com/hmarr/codeowners).
92+
Here's a quick example to get you started:
7793

7894
```go
7995
package main

0 commit comments

Comments
 (0)