Skip to content

Commit

Permalink
Add homebrew install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
CalebAlbers committed Jan 25, 2023
1 parent 0cbf7c3 commit a50f166
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# copywrite

This repo provides utilities for managing copyright headers and license files
in HashiCorp repos.
across many repos at scale.

You can use it to add or validate copyright headers on source code files, add a
LICENSE file to a repo, report on what licenses repos are using, and more.

## Getting Started

Copywrite is installable on Windows, Linux, and MacOS from the [releases](https://github.com/hashicorp/copywrite/releases) page.
The easiest way to get started is to use Homebrew:

```sh
brew tap hashicorp/tap
brew install hashicorp/tap/copywrite
```

Installers for Windows, Linux, and MacOS are also available on the [releases](https://github.com/hashicorp/copywrite/releases) page.

## CLI Usage

Expand Down Expand Up @@ -134,12 +141,12 @@ freely in later steps.
- name: Setup Copywrite
uses: hashicorp/setup-copywrite@main

...

- name: Check Header Compliance
run: copywrite headers --plan
```

:bulb: Running the copywrite command with the `--plan` flag will return a non-zero exit code if the repo is out of compliance.

## Development

### IDE Settings
Expand Down

0 comments on commit a50f166

Please sign in to comment.