diff --git a/README.md b/README.md index 561484c..b511ed2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,26 @@ # Kosmorro Tap -## How do I install these formulae? +This repository is the official Homebrew Tap to install and keep Kosmorro up to date on macOS. -`brew install kosmorro/tap/` +## How do I install formulae inside this Tap? -Or `brew tap kosmorro/tap` and then `brew install `. +First, tell Homebrew to subscribe to this Tap: + +```bash +brew tap kosmorro/tap +``` + +Then, use `brew install` to install a formula: + +```bash +brew install +``` + +Once installed, you will be able to get package updates as soon as they are published with `brew upgrade`. + +**Note:** this Tap is maintained for macOS only. On Linux, see the alternative ways on [Kosmorro website](https://kosmorro.space/cli/download/linux). ## Documentation -`brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh). +- To get help with Kosmorro-related projects, see [Kosmorro's website](https://kosmorro.space). +- To get help with Homebrew, enter `brew help` or `man brew` in your terminal, or check [Homebrew's documentation](https://docs.brew.sh).