Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
kirpichenko authored Mar 6, 2020
1 parent 2813da2 commit fd74da3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,17 @@ Generates `ts` files from `proto` file definitions.
curl -Lo protoc-gen-ts https://github.com/join-com/protoc-gen-ts/releases/download/[VERSION]/protoc-gen-ts-[VERSION] \
&& chmod +x protoc-gen-ts && sudo mv protoc-gen-ts /usr/local/bin
```

## Usage

```
protoc proto/*.proto -I proto --ts_out=proto-ts
```
will generate TS implementations into `proto-ts` folder for all your proto files inside `proto`

## Develop

1. Follow [instructions](https://golang.org/doc/install) to install Go and add /usr/local/go/bin to the PATH environment variable
2. Clone and navigate to repository and build package with `go install .`
3. Inside `integrationTests` file run `yarn proto:build` to generate files for test proto files
4. `yarn test` to run tests

0 comments on commit fd74da3

Please sign in to comment.