Skip to content

Commit

Permalink
Merge pull request #13 from twitchdev/feature/brew-release
Browse files Browse the repository at this point in the history
updating README to include Homebrew instructions
  • Loading branch information
lleadbet authored Jan 6, 2021
2 parents 1162c7e + 324b399 commit 2fc42f4
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,31 @@

- [Twitch CLI (Open Beta Version)](#twitch-cli-open-beta-version)
- [Download](#download)
- [Homebrew](#homebrew)
- [Manual Download](#manual-download)
- [Usage](#usage)
- [Commands](#commands)
- [Contributing](#contributing)
- [License](#license)

## Download

There are two options to download/install the Twitch CLI.

### Homebrew

If you are using MacOS or Linux, we recommend using [Homebrew](https://brew.sh/) for installing the CLI as it will also manage the versioning for you.

To install via Homebrew, run `brew install twitchdev/twitch/twitch-cli` and it'll be callable via `twitch`.

### Manual Download

To download, go to the [Releases tab of GitHub](https://github.com/twitchdev/twitch-cli/releases). The examples in the documentation assume you have put this into your PATH and renamed to `twitch` (or symlinked as such).

**Note**: if using Mac OS, you may need to adjust the permissions of the file to allow for execution. This is only temporary while we work to get this into Homebrew in the future.
**Note**: If using MacOS and downloading manually, you may need to adjust the permissions of the file to allow for execution.

To do so, please run: `chmod 755 <filename>` where the filename is the name of the downloaded binary.


## Usage

The CLI largely follows a standard format:
Expand Down

0 comments on commit 2fc42f4

Please sign in to comment.