Skip to content

Commit 86bd549

Browse files
committed
docs: add proto crate README
1 parent c8c7df5 commit 86bd549

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

crates/proto/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# inferadb-ledger-proto
2+
3+
Generated protobuf types, gRPC service traits, and domain type conversions for [InferaDB](https://github.com/inferadb) [Ledger](https://github.com/inferadb/ledger).
4+
5+
## Overview
6+
7+
This crate provides the wire-format layer for InferaDB Ledger:
8+
9+
- **Proto types**: Generated request/response messages, enums, and nested types
10+
- **gRPC traits**: Service definitions for Read, Write, Admin, Health, and Discovery
11+
- **Conversions**: Bidirectional `From`/`TryFrom` impls between proto and domain types
12+
13+
## Usage
14+
15+
```rust
16+
use inferadb_ledger_proto::proto::{
17+
WriteRequest, ReadRequest, Operation,
18+
write_service_client::WriteServiceClient,
19+
read_service_client::ReadServiceClient,
20+
};
21+
22+
// Convert between domain and proto types
23+
use inferadb_ledger_types::Operation as DomainOp;
24+
let domain_op = DomainOp::set_entity("key", b"value".to_vec());
25+
let proto_op: Operation = domain_op.into();
26+
```
27+
28+
## License
29+
30+
MIT OR Apache-2.0

0 commit comments

Comments
 (0)