Skip to content

Add documentation on how to run the example #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: base
Choose a base branch
from
Open

Add documentation on how to run the example #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,10 @@ store them in `protobuf/`. Generate the typescript files with `./scripts/generat

## Example

There is an example program in `src/example.ts` that uses the client and calls all of its endpoints.
There is an example program in `src/example.ts` that uses the client and calls all of its endpoints.

To run the example use [`npx`](https://docs.npmjs.com/cli/v8/commands/npx):

```sh
$ npx ts-node src/example.ts
```