Skip to content

Commit 1465cf3

Browse files
committed
repo: add basic README
1 parent fde0786 commit 1465cf3

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
11
# Flipchat Protobuf API
2+
3+
[![Release](https://img.shields.io/github/v/release/code-payments/flipchat-protobuf-api.svg)](https://github.com/code-payments/flipchat-protobuf-api/releases/latest)
4+
[![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)](https://github.com/code-payments/flipchat-protobuf-api/blob/main/LICENSE.md)
5+
6+
The APIs and models for communication between Flipchat clients and server.
7+
8+
## Code Generation
9+
10+
Generated code can be found under the `generated/` directory. The following languages are directly supported:
11+
- Go
12+
- TypeScript/JavaScript (via [Protobuf-ES](https://github.com/bufbuild/protobuf-es))
13+
14+
To generate all code, run:
15+
16+
```bash
17+
make
18+
```
19+
20+
Or to generate a specific language, run:
21+
22+
```bash
23+
make {go, protobuf-es}
24+
```

0 commit comments

Comments
 (0)