global: readmes

This commit is contained in:
nym21
2025-12-18 23:05:43 +01:00
parent 9ad3acbdf9
commit 57749da919
19 changed files with 44 additions and 28 deletions
+5 -1
View File
@@ -17,7 +17,7 @@ Serve BRK data via REST API with OpenAPI documentation, response caching, MCP en
## Core API
```rust
```rust,ignore
let server = Server::new(&async_query, Some(files_path));
server.serve(true).await?; // true enables MCP endpoint
```
@@ -45,6 +45,10 @@ Uses ETag-based caching with stale-while-revalidate semantics:
Server binds to port 3110 by default, auto-incrementing if busy (up to 3210).
## Recommended: mimalloc v3
Use [mimalloc v3](https://crates.io/crates/mimalloc) as the global allocator to reduce memory usage.
## Built On
- `brk_query` for data access