Skip to content

Commit

Permalink
Add install instructions & demo gif (#366)
Browse files Browse the repository at this point in the history
* Add demo gif

* Include gif in README
  • Loading branch information
mcncl authored Sep 19, 2024
1 parent 1250b43 commit 583e891
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,20 @@ A command line interface for [Buildkite](https://buildkite.com/).

Use `bk` to interact with your Buildkite organization without leaving the terminal 🙌.

![bk cli](./images/demo.gif)

## Installing

### Using the binary

`bk` is available as a downloadable binary from the [releases page](https://github.com/buildkite/cli/releases).

### Using Brew

```sh
brew tap buildkite/buildkite && brew install buildkite/buildkite/bk
```

## Usage

```
Expand Down
Binary file added images/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 583e891

Please sign in to comment.