summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 01e35a5..04c68fa 100644
--- a/README.md
+++ b/README.md
@@ -85,6 +85,13 @@ at once or later; a read or write may park with `Status.again` and is retried.
Table sizes are comptime `fs.Options`; nothing allocates. See
[the engine's contract](docs/design.md#file-server-engine).
+On a hosted target, `serve.Runner(Backend, options, limits)` runs that engine
+on `std.Io`: `listen()` on Unix or TCP addresses, a bounded connection table,
+two tasks per connection, a handler the backend answers through `Conn.reply()`
+now or later, `Conn.wake()` to retry parked reads when the backend has news,
+and `stop()` to close and join. Freestanding targets keep the push/step loop.
+See [the Io runner](docs/design.md#io-runner).
+
## Programs
Related programs live in `cloud9/<name>/`, one directory per program beside