feat: add custom-router example (#138)

adds an example for how to implement a custom router which allows adding and removing protocols at runtime.

moved over from n0-computer/iroh#3367

Author: Frando

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ env:
   RUSTFLAGS: -Dwarnings
   RUSTDOCFLAGS: -Dwarnings
   MSRV: "1.81"
-  RS_EXAMPLES_LIST: "dumbpipe-web,extism/host,extism/iroh-extism-host-functions,extism/plugin,iroh-automerge,iroh-automerge-repo,iroh-gateway,frosty,browser-echo,framed-messages"
+  RS_EXAMPLES_LIST: "dumbpipe-web,extism/host,extism/iroh-extism-host-functions,extism/plugin,iroh-automerge,iroh-automerge-repo,iroh-gateway,frosty,browser-echo,framed-messages,custom-router"
   WASM_EXAMPLES_LIST: "browser-echo"
   IROH_FORCE_STAGING_RELAYS: "1"
 

README.md

@@ -16,6 +16,13 @@ Use iroh in the browser, compiled to web assembly. [Try it here!](https://n0-com
 A chat app based on iroh-gossip that can run both in the browser and on the command line.
 [Try it here!](https://n0-computer.github.io/iroh-examples/main/browser-chat/index.html)
 
+### [custom-router](custom-router)
+
+When you need more control or customizations than the
+[iroh `Router`](https://docs.rs/iroh/latest/iroh/protocol/struct.Router.html) allows, we
+recommend to build your own router instead. This example implements a router that allows
+to add and remove protocols at runtime.
+
 ### [dumbpipe-web](dumbpipe-web)
 
 Forward http requests to dumbpipe. Share a local dev server publicly.