mirror of
https://github.com/sigp/lighthouse.git
synced 2026-05-07 16:55:46 +00:00
Document Homebrew package (#2885)
## Issue Addressed Resolves #2329 ## Proposed Changes Documents the recently added `lighthouse` Homebrew formula. ## Additional Info NA Co-authored-by: Richard Patel <richard@blockdaemon.com> Co-authored-by: Michael Sproul <micsproul@gmail.com>
This commit is contained in:
36
book/src/homebrew.md
Normal file
36
book/src/homebrew.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Homebrew package
|
||||
|
||||
Lighthouse is available on Linux and macOS via the [Homebrew package manager](https://brew.sh).
|
||||
|
||||
Please note that this installation method is maintained by the Homebrew community.
|
||||
It is not officially supported by the Lighthouse team.
|
||||
|
||||
### Installation
|
||||
|
||||
Install the latest version of the [`lighthouse`][formula] formula with:
|
||||
|
||||
```bash
|
||||
brew install lighthouse
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
If Homebrew is installed to your `PATH` (default), simply run:
|
||||
|
||||
```bash
|
||||
lighthouse --help
|
||||
```
|
||||
|
||||
Alternatively, you can find the `lighthouse` binary at:
|
||||
|
||||
```bash
|
||||
"$(brew --prefix)/bin/lighthouse" --help
|
||||
```
|
||||
|
||||
### Maintenance
|
||||
|
||||
The [formula][] is kept up-to-date by the Homebrew community and a bot that lists for new releases.
|
||||
|
||||
The package source can be found in the [homebrew-core](https://github.com/Homebrew/homebrew-core/blob/master/Formula/lighthouse.rb) repo.
|
||||
|
||||
[formula]: https://formulae.brew.sh/formula/lighthouse
|
||||
Reference in New Issue
Block a user