From 3e623737dd43347da2b86272036dd18f3f0b6d0a Mon Sep 17 00:00:00 2001
From: tarotene <tarotene@gmail.com>
Date: Sat, 27 Jun 2026 00:26:49 +0900
Subject: [PATCH] fix(server,docs): correct ShimFn return type in README

The CommandMetadata code block in telepath-server/README.md showed the
ShimFn return type as `Result<usize, DispatchError>`, but the actual
type alias in src/lib.rs returns `Result<DispatchOutcome, DispatchError>`.

This fixes the doc/source mismatch so readers integrating against
CommandMetadata see the correct shim signature.

References:
- telepath-server/src/lib.rs:71-75 (canonical ShimFn definition)
---
 telepath-server/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/telepath-server/README.md b/telepath-server/README.md
index 1d18687..c540d79 100644
--- a/telepath-server/README.md
+++ b/telepath-server/README.md
@@ -51,7 +51,7 @@ Both methods are non-blocking and return the number of bytes transferred.
 pub struct CommandMetadata {
     pub name: &'static str,
     pub id: u16,
-    pub invoke: ShimFn,         // fn(&[u8], &mut [u8], &ResourceRegistry) -> Result<usize, DispatchError>
+    pub invoke: ShimFn,         // fn(&[u8], &mut [u8], &ResourceRegistry) -> Result<DispatchOutcome, DispatchError>
     pub args_schema: SchemaFn,  // fn(&mut [u8]) -> Result<usize, ()>
     pub ret_schema: SchemaFn,   // fn(&mut [u8]) -> Result<usize, ()>
     pub arg_names: &'static str, // comma-separated, e.g. "a,b"