Skip to content

Commit f209b88

Browse files
committed
docs
1 parent 0aa0bc8 commit f209b88

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Protoc Gen Typescript
22

3+
[![test](https://github.com/thesayyn/protoc-gen-ts/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/thesayyn/protoc-gen-ts/actions/workflows/test.yaml)
34
![npm](https://img.shields.io/npm/v/protoc-gen-ts)
4-
![npm bundle size](https://img.shields.io/bundlephobia/min/protoc-gen-ts)
55
![npm](https://img.shields.io/npm/dm/protoc-gen-ts)
66

77
Generates appropriate Protocol Buffer sources from Proto files directly through _TypeScript Compiler API_.
@@ -64,8 +64,6 @@ You can also support me directly by buying me one or two coffee,
6464
<img height="40px" src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=🙌&slug=thesayyn&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff">
6565
</a>
6666

67-
68-
6967
## Key Differences
7068

7169
This protoc plugin does generate;
@@ -102,6 +100,10 @@ ts_proto_library(
102100
```
103101

104102

103+
## Usage with @grpc/grpc-js or grpc
104+
105+
There is a seperate documentation for the usage of protoc-gen-ts along with either `@grpc/grpc-js` or `grpc`
106+
105107
## Environment variables
106108

107109
```sh

0 commit comments

Comments
 (0)