Skip to content

Commit

Permalink
Update README with new login details.
Browse files Browse the repository at this point in the history
Updates the README file with the new `login` process. To also include
usage of an API Key via the `CB_API_KEY` env.
  • Loading branch information
abrightwell committed Aug 14, 2023
1 parent 2a0f95a commit 91d44a6
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,21 @@ A CLI for Crunchy Bridge with very good tab completion.

## Getting started

First get your `application ID` and `application secret` from https://www.crunchybridge.com/account
First login to your Crunchy Bridge account by running `cb login`.

Then run `cb login` to register the CLI with your Crunchy Bridge account.
```
$ cb login
Press any key to open a browser to login or q to exit:
Waiting for login... done
Logged in as [email protected]
```

If you'd prefer to use an API key then you can create one for your
[account](https://crunchybridge.com/account/api-keys) and set the `CB_API_KEY`
environment variable.

**Note:** If the `CB_API_KEY` envrionment variable is set, then `cb login` will not
work until it is unset.

## Usage

Expand Down

0 comments on commit 91d44a6

Please sign in to comment.