Skip to content

Commit

Permalink
Merge pull request #5 from taskcluster/matt-boris/docs
Browse files Browse the repository at this point in the history
Add README.md and update description and homepage
  • Loading branch information
lotas authored Aug 3, 2022
2 parents fb4d69b + 6ec15e1 commit 1fc8f5f
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Formula/taskcluster.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
class Taskcluster < Formula
desc "CI for Engineers"
homepage "https://taskcluster.net"
desc "A Taskcluster client library for the command line"
homepage "https://github.com/taskcluster/taskcluster/tree/main/clients/client-shell"
version "v44.17.2"
license "MPL-2.0"

Expand Down
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Taskcluster Homebrew Tap

This [Homebrew](https://docs.brew.sh/) Tap provides the Taskcluster team a place to build and share their own Homebrew formulae. You can find out more information about how third party Homebrew Taps are created and maintained in [Homebrew's documentation](https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap).

Currently available formulae can be found in the [`Formula` directory](./Formula/) at the root of the Tap.

### Tapping

To tap the Homebrew Tap without installing any formulae, you can use the following command:

```bash
brew tap taskcluster/tap
```

For more information about the `brew tap` command, see the [Homebrew documentation](https://docs.brew.sh/Taps).

### Installing Formulae

To install a specific formula, such as `taskcluster` to install the [Taskcluster CLI](https://github.com/taskcluster/taskcluster/tree/main/clients/client-shell), you can use the following command:

```bash
# to install without having to tap the Homebrew Tap first
brew install taskcluster/tap/taskcluster
```
```bash
# to install if you've already tapped the Homebrew Tap
brew install taskcluster
```

### Uninstalling Formulae

To uninstall a specific formula, such as `taskcluster`, you can use the following command:

```bash
brew uninstall taskcluster
```

### Untapping

To untap the Homebrew Tap, you can use the following command:

```bash
brew untap taskcluster/tap
```

0 comments on commit 1fc8f5f

Please sign in to comment.