Skip to content

Commit

Permalink
Merge pull request #17 from paradigmxyz/onbjerg/docs
Browse files Browse the repository at this point in the history
docs: document updating formula
  • Loading branch information
onbjerg authored Aug 15, 2023
2 parents 65e1ff6 + f0960c8 commit beda5df
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
## How do I install these formulae?
## Paradigm Brew Formulae

`brew install paradigmxyz/brew/<formula>`
Homebrew formulae and casks for various Paradigm software.

Or `brew tap paradigmxyz/brew` and then `brew install <formula>`.
### How do I install these formulae?

## Documentation
Either install directly using `brew install paradigmxyz/brew/<formula>`, or add the tap first `brew tap paradigmxyz/brew` and then use `brew install <formula>`.

`brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).
### How do I update the formulae?

1. Open a PR, changing the tag and revision as appropriate (revision should point to the tagged commit)
2. Wait for CI to finish
3. Add the `pr-pull` label, which will do a bunch of housekeeping for you and merge the PR[^1]

[^1]: The PR will be closed

0 comments on commit beda5df

Please sign in to comment.