Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidSGK committed Nov 16, 2023
1 parent bb30c58 commit de745cf
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@

CLI Interface to the Lekko Dynamic Configuration Platform.

## Documentation
## Documentation

Find our documentation at https://app.lekko.com/docs.

## Download

To download `lekko` cli, you can use homebrew. Since the code is still in a private repository, you will need to use a Github personal access token that has been given access to `lekkodev/homebrew-lekko` and `lekkodev/cli` repos.
To download `lekko` cli, you can use homebrew.

```bash
export HOMEBREW_GITHUB_API_TOKEN=<MY_GITHUB_TOKEN>
brew tap lekkodev/lekko
brew install lekko
```
Expand Down Expand Up @@ -42,6 +41,8 @@ This command will first prompt you for a new tag that it will push to GitHub. Th

After completion, navigate to https://github.com/lekkodev/cli/releases/ to see the latest releases under the tag you just created.

Because the CLI repository is still private, the releaser is configured to publish the compiled assets to a public S3 bucket (`lekko-cli-releases`). The releaser is also responsible for generating/updating the homebrew formula for the lekkodev/lekko brew [tap](https://github.com/lekkodev/homebrew-lekko), which will download and install the CLI from that bucket.

Done! The cli has just been released. Follow instructions above to [Download](#download) the latest cli.

## Integration Tests
Expand Down

0 comments on commit de745cf

Please sign in to comment.