From fd74da3e4b58e80ee5fc82203aece1b6ac1fbad0 Mon Sep 17 00:00:00 2001 From: Ievgen Kyrpychenko Date: Fri, 6 Mar 2020 14:46:06 +0100 Subject: [PATCH] Update readme.md Update readme --- readme.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/readme.md b/readme.md index cd8d3c1..7366600 100644 --- a/readme.md +++ b/readme.md @@ -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