Skip to content

Add docs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Karolk99 merged 2 commits into from
Nov 15, 2024
Merged

Add docs #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6bbaf3
Add docs
Karolk99 Nov 14, 2024
2a9e7fd
Requested changes
Karolk99 Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,23 @@

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

`git submodule add https://github.com/fishjam-cloud/protos.git`
Install [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) plugin.

Use the command below:
```command
protoc --doc_out=./doc --doc_opt=markdown,docs.md fishjam/**/*.proto
```

## Copyright and License

Expand Down
Loading