doc(hyperserve): README

Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
feathers-studio · Feb 10, 2022 · 9dd45c5 · 9dd45c5
1 parent ae015b6
commit 9dd45c5
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/serve/README.md b/serve/README.md
@@ -0,0 +1,17 @@
+# hyperserve
+
+Part of the [hyperactive](https://github.com/feathers-studio/hyperactive) project. A lean server library that's functional by design and integrates seamlessly with hyperactive itself.
+
+## Getting started
+
+```TypeScript
+import { http, router, get } from "https://deno.land/x/hyperactive/serve.ts";
+
+const server = http({ port: 3000 }, router(
+	get("/", ctx => ctx.respond("Hello world")),
+	...
+));
+
+server.start();
+console.log("Listening on port", 3000);
+```