Skip to content
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

chore(docs): updating readme #2

Merged
merged 2 commits into from
Jun 29, 2024
Merged

chore(docs): updating readme #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd22d00
chore(docs): updating readme
madflojo Jun 29, 2024
cf9b2aa
Update README.md
madflojo Jun 29, 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
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
# protobuf-definitions
Protobuf definitions for function to host callbacks
# Tarmac Protobuf Definitions

This repository contains the protobuf definitions for the Tarmac project.

The protobuf definitions are used by Tarmac SDKs or functions directly to perform host calls to the Tarmac server.
Communication between the Tarmac server and functions/SDKs is via [waPC](https://wapc.io/) WebAssembly Procedure Calls.

## Structure

| Proto File | Description |
|------------|-------------|
| `tarmac.proto` | Contains common messages used for various message types. |
| `kvstore.proto` | Protobuf definitions for KVStore related messages. |
| `metrics.proto` | Protobuf definitions for Metrics related messages. |
| `http.proto` | Protobuf definitions for HTTP client related messages. |
| `sql.proto` | Protobuf definitions for SQL query related messages. |

## Contributing

Contributions are welcome, please open an issue or submit a pull request for any changes or improvements.