Skip to content

Commit

Permalink
chore(lk): last looks for 2.1.0 release (#397)
Browse files Browse the repository at this point in the history
* chore(lk): bump version for 2.1.0 release

* fix(auth): set default based on final (deduped) project name

* chore(docs): update readme to include auth instructions
  • Loading branch information
rektdeckard authored Aug 22, 2024
1 parent a970847 commit d63cee8
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,19 @@ make install

See `lk --help` for a complete list of subcommands.

## Set up your project [new]
## Set up your project (new)

When a default project is set up, you can omit `url`, `api-key`, and `api-secret` when using the CLI.
You can also set up multiple projects, and temporarily switch the active project used with the `--project` flag, or persistently using `lk project set-default`.
The quickest way to get started is to authenticate with your LiveKit Cloud account and link an existing project. If you haven't created an account or project yet, head [here](https://cloud.livekit.io) first. Then run the following:

### Adding a project
```shell
lk cloud auth
```

Follow the URL to login in the browser and choose your project to link. When you return to your terminal, you'll have the option to use this project as the default.

When a default project is set up, you can omit `url`, `api-key`, and `api-secret` when using the CLI. You can also set up multiple projects, and temporarily switch the active project used with the `--project` flag, or persistently using `lk project set-default`.

### Adding a project manually

```shell
lk project add --api-key <key> --api-secret <secret> <project_name>
Expand All @@ -83,7 +90,7 @@ lk project set-default <project_name>

### Publish demo video track

To publish a demo video as a participant's track, use the following.
To publish a demo video as a participant's track, use the following:

```shell
lk room join --identity publisher --publish-demo <room_name>
Expand Down
2 changes: 1 addition & 1 deletion cmd/lk/cloud.go
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ func tryAuthIfNeeded(ctx context.Context, cmd *cli.Command) error {
})

if isDefault {
cliConfig.DefaultProject = ak.Description
cliConfig.DefaultProject = name
}
if err = cliConfig.PersistIfNeeded(); err != nil {
return err
Expand Down
2 changes: 1 addition & 1 deletion version.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@
package livekitcli

const (
Version = "2.0.4"
Version = "2.1.0"
)

0 comments on commit d63cee8

Please sign in to comment.