Skip to content

Commit b4d49be

Browse files
docs: update README with service discovery details
Signed-off-by: Gyokhan Kochmarla <gokhan.kocmarli@gmail.com>
1 parent 0bf5514 commit b4d49be

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- Thread-safe Topic Broker with wildcard support (`+`, `#`)
1515
- Custom Protobuf Engine with runtime `.proto` schema parsing
1616
- Topic-based Protobuf schema routing
17+
- **Service Discovery & Schema Registry**: Clients can ask the server "what can I send?" and receive the full `.proto` definitions at runtime.
1718
- MQTT CLI client with automatic JSON-to-Protobuf encoding
1819
- Structured diagnostic output for Protobuf payloads
1920

@@ -49,6 +50,17 @@ For the initial release, we support:
4950
- No retained messages
5051
- Single-node deployment
5152

53+
### Service Discovery
54+
55+
ProtoMQ includes a built-in Service Discovery mechanism. Clients can discover available topics and their associated Protobuf schemas (including the full source code) by querying the `$SYS/discovery/request` topic.
56+
57+
**Using the CLI for discovery:**
58+
```bash
59+
# Verify schemas are loaded and available
60+
protomq-cli discover --proto-dir schemas
61+
```
62+
This allows clients to "bootstrap" themselves without needing pre-shared `.proto` files.
63+
5264
### Performance Results
5365

5466
ProtoMQ delivers high performance across both high-end and edge hardware:

0 commit comments

Comments
 (0)