diff --git a/README.md b/README.md
index bf0f565..4d59359 100644
--- a/README.md
+++ b/README.md
@@ -65,23 +65,26 @@ The router is then used with your web server of choice, e.g. `Deno.serve` or `Bu
```js
import * as Peko from "@sejori/peko"; // or https://deno.land/x/peko/mod.ts in Deno
-const router = new Peko.Router();
+const router = new Peko.HttpRouter();
-router.use(Peko.logger(console.log));
+router.use(Peko.log(console.log));
-router.get("/shorthand-route", () => new Response("Hello world!"));
+router.GET("/shorthand-route", [], () => new Response("Hello world!"));
-router.post(
+router.POST(
"/shorthand-route-ext",
- async (ctx, next) => {
- await next();
- console.log(ctx.request.headers);
- },
+ [
+ async (ctx, next) => {
+ await next();
+ console.log(ctx.request.headers);
+ }
+ ],
(req) => new Response(req.body)
);
router.addRoute({
path: "/object-route",
+ method: "GET",
middleware: async (ctx, next) => {
await next();
console.log(ctx.request.headers);
@@ -100,65 +103,30 @@ Deno.serve((req) => router.handle(req));
- `git clone https://github.com/sejori/peko` && `cd peko`
-Check `example` directory to see implementations of:
-
-- server-side rendering react to HTML
-- streaming server-sent events to web client
-- logging requests
-- caching responses
-- JWT authentication middleware
-
**Deno [Live Deploy](https://peko.deno.dev)**
- Process 1: `deno task dev:build`
- Process 2: `deno task dev:deno`
-**Cloudflare Workers [Live Deploy](https://peko.sejori.workers.dev)**
+**Cloudflare Workers**
- `npm i`
- Process 1: `npm run dev:build`
- Process 2: `npm run dev:wrangler`
**Bun:**
-Bun is currently not deployed but it is profiled against Deno, check the GitHub actions to see results.
- `bun install`
- Process 1: `bun dev:build`
- Process 2: `bun dev:bun`
-Types
-
-### [**Router**](https://deno.land/x/peko/mod.ts?s=Router)
-
-The main class/entrypoint of Peko.
-
-The `handle` method generates a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response) from a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request) argument via configured routes and middleware.
-
-### [**Route**](https://deno.land/x/peko/mod.ts?s=Route)
-
-Routes are added to a `Router` and matched to a `Request` via their `path` property. Once matched, the route's `middleware` and `handlers` are invoked to process the `Request` (after global middleware on the `Router`).
-
-Dynamic path parameters are supported in the `/users/:userid` syntax.
-
-### [**RequestContext**](https://deno.land/x/peko/mod.ts?s=RequestContext)
-
-An object containing request data that is passed into middleware and handlers in the `Request` process lifecycle.
-
-The `state` property is an object designed to transfer information between middleware/handlers.
+Note: Runtimes are profiled for speed - view the GitHub actions to see results.
-### [**Middleware**](https://deno.land/x/peko/mod.ts?s=Middleware)
+Examples
-Functions that receive `RequestContext` and `next`. They are designed to:
+Check out the `examples` dir for React server-side rendering as well as a basic auth demo.
-- Return a `Response` and end the `Request` processing lifecycle (e.g. returning a `401`)
-- Call `await next()` to access the final response (e.g. logging)
-- Edit the context's `state` (e.g. rendering geolocation to HTML)
-
-### [**Handler**](https://deno.land/x/peko/mod.ts?s=Handler)
-
-The final request handling function on a `Route`, receives `RequestContext` argument.
-
-Must return/resolve to a `Response` (e.g. Render HTML or return JSON payload).
+For a comprehensive product demo check out: https://panplan.ai - built entirely with Peko and React on Cloudflare Workers.
Recipes
@@ -192,9 +160,9 @@ router.use(async (_, next) => {
In stateless computing, memory should only be used for source code and disposable cache data. Response caching ensures that we only store data that can be regenerated or refetched. The configurable `cacher` middleware provides drop in handler memoization and response caching for your routes.
```js
-router.addRoute(
+router.GET(
"/get-time",
- Peko.cacher({ itemLifetime: 5000 }),
+ [Peko.cache({ itemLifetime: 5000 })],
() => new Response(Date.now())
);
```
@@ -202,43 +170,27 @@ router.addRoute(
The cacher stores response items in memory by default, but it can be extended to use any key value storage by supplying the `store` options parameter (e.g. Cloudflare Workers KV).
```js
-import { Router, CacheItem, cacher } from "@sejori/peko";
-
-const router = new Router();
+import { HttpRouter, CacheItem, cache } from "@sejori/peko";
+const router = new HttpRouter();
const itemMap: Map = new Map();
-router.addRoute("/get-time", {
- middleware: cacher({
- itemLifetime: 5000,
- store: {
- get: (key) => itemMap.get(key),
- set: (key, value) => itemMap.set(key, value),
- delete: (key) => itemMap.delete(key),
- },
- }),
- handler: () => new Response(Date.now()),
-});
+router.GET(
+ "/get-time",
+ [
+ cache({
+ itemLifetime: 5000,
+ store: {
+ get: (key) => itemMap.get(key),
+ set: (key, value) => itemMap.set(key, value),
+ delete: (key) => itemMap.delete(key),
+ },
+ })
+ ],
+ () => new Response(Date.now()),
+);
```
-Showcase
-
-PR to add your project 🙌
-
-### [shineon.systems](https://shineon.systems)
-
-- **Stack:** React, Cloudflare Workers, KV and R2
-- **Features:** KV cache, R2 email list, Markdown rendering
-- [source](https://github.com/shine-systems/shineponics/blob/main/server.ts)
-
-### [thesebsite.deno.dev](https://thesebsite.deno.dev)
-
-- **Stack:** HTML5
-- **Features:** UI TS scripts transpiled to JS and cached for browser
-- [source](https://github.com/sebringrose/peko/blob/main/examples/auth/app.ts)
-
-**Note:** [lit-html](https://marketplace.visualstudio.com/items?itemName=bierner.lit-html) and [es6-string-css](https://marketplace.visualstudio.com/items?itemName=bashmish.es6-string-css) VS Code extensions recommended.
-
Motivations
### Apps on the edge