From dd22d00841966bc08117a313730fb7872cecd82b Mon Sep 17 00:00:00 2001 From: Benjamin Cane Date: Sat, 29 Jun 2024 10:25:04 -0700 Subject: [PATCH 1/2] chore(docs): updating readme --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab366f4..23e4dfe 100644 --- a/README.md +++ b/README.md @@ -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. From cf9b2aab9f86ea0d9f6b98455f354485cd2b512a Mon Sep 17 00:00:00 2001 From: Benjamin Cane Date: Sat, 29 Jun 2024 10:54:25 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 23e4dfe..9467012 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,4 @@ Communication between the Tarmac server and functions/SDKs is via [waPC](https:/ ## Contributing -Contributions are welcome please open an issue or submit a pull request for any changes or improvements. +Contributions are welcome, please open an issue or submit a pull request for any changes or improvements.