Skip to content

Commit

Permalink
Merge pull request #370 from hspedro/main
Browse files Browse the repository at this point in the history
Fix pitaya-cli broken refs on README
  • Loading branch information
vitorbaraujo authored Nov 28, 2023
2 parents 7397a0c + 1a2f6f1 commit 8676b1a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ make setup

Here's one example of running Pitaya:

Start etcd (This command requires docker-compose and will run an etcd container locally. An etcd may be run without docker if prefered.)
Start etcd (This command requires docker-compose and will run an etcd container locally. An etcd may be run without docker if preferred.)
```
cd ./examples/testing && docker-compose up -d etcd
```
Expand All @@ -57,7 +57,7 @@ run the room backend server from the cluster_grpc example
make run-cluster-grpc-example-room
```

Now there should be 2 pitaya servers running, a frontend connector and a backend room. To send requests, use a REPL client for pitaya [pitaya-cli](https://github.com/topfreegames/pitaya/tree/main/cli).
Now there should be 2 pitaya servers running, a frontend connector and a backend room. To send requests, use a REPL client for pitaya [pitaya-cli](https://github.com/topfreegames/pitaya/tree/main/pitaya-cli).

```
$ pitaya-cli
Expand Down Expand Up @@ -96,7 +96,7 @@ If you have found a security vulnerability, please email [email protected]
+ [libpitaya](https://github.com/topfreegames/libpitaya)
+ [pitaya-admin](https://github.com/topfreegames/pitaya-admin)
+ [pitaya-bot](https://github.com/topfreegames/pitaya-bot)
+ [pitaya-cli](https://github.com/topfreegames/pitaya/tree/main/cli)
+ [pitaya-cli](https://github.com/topfreegames/pitaya/tree/main/pitaya-cli)
+ [pitaya-protos](https://github.com/topfreegames/pitaya-protos)

- Documents
Expand Down
4 changes: 2 additions & 2 deletions pitaya-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A REPL cli client made in go for pitaya.
## Installing

```
go install github.com/topfreegames/pitaya/v2/pitaya-cli
go install github.com/topfreegames/pitaya-cli/v2@latest
```

## Usage
Expand Down Expand Up @@ -80,7 +80,7 @@ func (c *MyHandler) Descriptors(ctx context.Context, names *protos.ProtoNames) (
}
```

When initilizing the CLI, you have to provide the docs route as the following:
When initializing the CLI, you have to provide the docs route as the following:
```
pitaya-cli -docs connector.docsHandler.docs
```
Expand Down

0 comments on commit 8676b1a

Please sign in to comment.