https://github.com/fishjam-cloud/protos
https://github.com/fishjam-cloud/protos
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fishjam-cloud/protos
- Owner: fishjam-cloud
- License: apache-2.0
- Created: 2024-06-17T13:44:30.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2026-02-09T10:48:26.000Z (5 months ago)
- Last Synced: 2026-02-22T21:50:55.991Z (4 months ago)
- Language: Elixir
- Size: 109 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Protos
This repository contains protocol buffers definitions for [fishjam-cloud organization](https://github.com/fishjam-cloud) repositories.
For detailed protobuf definitions and usage, please refer to the [documentation](./doc/docs.md).
## How to add this repo as a git submodule in your own repository
Use the command below:
```command
git submodule add https://github.com/fishjam-cloud/protos.git`
```
## How to update docs
Install [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) plugin.
Use the command below:
```command
find fishjam/ -name "*.proto" | sort | xargs protoc --doc_out=./doc --doc_opt=markdown,docs.md
```
or
```command
find fishjam -name "*.proto" | sort | xargs docker run --rm -v $(pwd)/doc:/out -v $(pwd):/protos pseudomuto/protoc-gen-doc --doc_opt=markdown,docs.md
```
## Lint and formatting
The files can be formatted using `buf`.
Check out [installation page](https://buf.build/docs/installation/) for `buf`.
```
buf format -w
```
and linted
```
buf lint
```
## Copyright and License
Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam-protos)
[](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane_rtc_engine)
Licensed under the [Apache License, Version 2.0](LICENSE)