@marko/run 0.0.1-beta1 → 0.0.1-beta10

package/README.md

@@ -1,82 +1,88 @@
-<h1 align="center">
-  <!-- Logo -->
-  <img src="https://user-images.githubusercontent.com/4985201/115444712-ca550500-a1c9-11eb-9897-238ece59129c.png" height="118"/>
-  <br/>
-  @marko/run
-	<br/>
-
-  <!-- Language -->
-  <a href="http://typescriptlang.org">
-    <img src="https://img.shields.io/badge/%3C%2F%3E-typescript-blue.svg" alt="TypeScript"/>
-  </a>
-</h1>
-
-Vite plugin for Marko with these features
-- Encapsulates [@marko/vite](https://github.com/marko-js/vite)
-- File-based routing with layouts and middleware
-- Efficient routing using a compiled static trie
-- Designed with web standards to run anywhere
-
-## Intallation
 
-```
+
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/marko-js/run/raw/main/assets/marko-run-darkmode.png">
+    <source media="(prefers-color-scheme: light)" srcset="https://github.com/marko-js/run/raw/main/assets/marko-run.png">
+    <img alt="Marko Run Logo" src="https://github.com/marko-js/run/raw/main/assets/marko-run.png" width="400">
+  </picture>
+  <h4>Get your app up and <em>running</em> with <a href="https://markojs.com">Marko</a>!</h4>
+</div>
+
+## Features
+* 🚀 Fastest way to build a Marko app
+* 💖 Scales from zero configuration
+* ⚡️ Pages live-reload as you make changes
+* 📁 Directory-based routes, layouts and middleware
+* 🖌️ TypeScript powered editor support
+* 🧬 [Designed with web standards](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern/URLPattern) to run anywhere
+
+And when you build your production-ready app:
+
+* 🔥 Blazing fast server-side rendering
+* 🌊 Streams content to users ASAP
+* 📦 Partial hydration & automatic code splitting
+* 🚢 Deploy to multiple platforms
+
+## Installation
+
+> **Warning**
+> This project is in BETA - use at your own peril, but please do provide helpful feedback.
+
+
+```sh
 npm install @marko/run
 ```
 
-## Vite Plugin
+### Getting Started / Zero Config
 
-This package provides both a Vite plugin and a runtime import. The Vite plugin is responsible for discovering your route files, generating the routing code and registering the @marko/vite plugin which builds your .marko files.
+`marko-run` makes it easy to get started without little to no config. The package ships with a default Vite config and node-based adapter.
 
-```ts
-// vite.config.ts
-import { defineConfig } from "vite";
-import marko from "@marko/run/vite"; // Import the Vite plugin
+To get started from a template:
+1. `npm init marko -- -t basic`
+2. `cd ./<PROJECT_NAME>`
+4. `npm run dev`
 
-export default defineConfig({
-  plugins: [marko()], // Register the Vite plugin
-  build: {
-    sourcemap: true, // Generate sourcemaps for all builds.
-    emptyOutDir: false, // Avoid server & client deleting files from each other.
-  }
-})
-```
+Or manually create a project:
+1. Install `@marko/run`
+2. Create file `src/routes/+page.marko`
+3. Run `npm exec marko-run`
 
-## Runtime
+Finally open `http://localhost:3000` 🚀
 
-Generally you'll want to use one of the adapters to provide a more convenient experience but this package provides the following runtime interface:
+### CLI
 
-```ts
-import { router, getMatchedRoute } from '@marko/run`;
+**`dev`** - Start development server in watch mode
+```bash
+> npm exec marko-run
+```
+or (with explicit sub command)
+```bash
+> npm exec marko-run dev
 ```
 
-### `router`
-```ts
-(request: Request) => Promise<Response>;
+
+**`build`** - Create a production build
+```bash
+> npm exec marko-run build
 ```
-This asynchronouse function takes a [WHATWG request](https://fetch.spec.whatwg.org/#request-class) object and returns a [response](https://fetch.spec.whatwg.org/#response-class) object generated by executing the corresponding matched route files. If no match is found, a response with a 404 status code is returned. If an unhandled error occurs, a response with a 500 status code will be returned.
 
-### `getMatchedRoute`
-```ts
-(method: string, url: URL) => {
-  params: Record<string, string>;
-  meta: unknown;
-  invoke(request: Request): Promise<Response>;
-} | null;
+**`preview`** - Create a production build and start preview server
+```bash
+> npm exec marko-run preview
 ```
-This synchronous function takes a HTTP verb method, and URL and returns an object representing the best match or null if no match is found.
-- `params` - a key-value collection of any path parameters for the route
-- `meta` - meta data for the route
-- `invoke` - an asynchronouse function that takes a WHATWG request and returns the response generated by executing the matched route files. Note: unlike the top-level `router` function errors will not be caught.
 
 ## File-based Routing
 
-## Nested Routing
+<!-- ### Nested Routing
 
-*TODO: provide a quick overview*
+*🎗 TODO: provide a quick overview* -->
 
 ### Routes Directory
 
-By default, the plugin will look for files in the configured _routes directory_. By default it will look in `./src/routes` (relative to the Vite config file) which can be configured:
+The plugin looks for route files in the configured **routes directory**. By default, that’s `./src/routes`, relative to the Vite config file.
+
+To change what directory routes are found in:
 
 ```ts
 // vite.config.ts
@@ -86,85 +92,104 @@ import marko from "@marko/run/vite";
 export default defineConfig({
   plugins: [marko({
     routesDir: 'src/pages' // Use `./src/pages` (relative to this file) as the routes directory
-  })],
-  //...
+  })]
 })
 ```
 
 ### Routeable Files
 
-In order to allow for co-location of files that should not be served (e.g. tests, stories, assets), the router only recognizes a specific set of file names. The following files will be discovered in any directory within your application's _routes directory_.
+To allow for colocation of files that shouldn’t be served (like tests, assets, etc.), the router only recognizes certain filenames.
+
+The following filenames will be discovered in any directory inside your application’s [routes directory](#routes-directory).
 
 #### `+page.marko`
-These files establish a route at the current directory path which will be served for GET requests with the HTML content of the page. Only one page may exists for any served path.
+
+These files establish a route at the current directory path which will be served for `GET` requests with the HTML content of the page. Only one page may exists for any served path.
 
 #### `+layout.marko`
-These files provide a layout component which will wrap all nested layouts and pages.
 
-<details>
-  <summary>More Info</summary>
-  
-  Layouts are just like any other Marko component with no extra constraints. Each layout receives the request, path params, URL and route meta data as input as well as a renderBody which will be the subsequent layout or page to project. 
-
-  ```marko
-  <div>
-    <h1>My Products</h1>
-    <main>
-      ${input.renderBody} // project the page or layout here
-    </main>
-  </div>
-  ```
-</details>
+These files provide a **layout component**, which will wrap all nested layouts and pages.
+
+Layouts are like any other Marko component with no extra constraints. Each layout receives the request, path params, URL, and route metadata as input, as well as a `renderBody` which will be the next layout or page to project. 
+
+```marko
+<main>
+  <h1>My Products</h1>
+
+  <${input.renderBody}/> // render the page or layout here
+</main>
+```
 
 #### `+handler.*`
-These files establish a route at the current directory path which can handle requests for GET, POST, PUT and DELETE HTTP verbs. Typically these will be .js or .ts files depending on your project. Just like pages, only one handler may exist for any served path. A handler should export functions
+
+These files establish a route at the current directory path which can handle requests for `GET`, `POST`, `PUT`, and `DELETE` HTTP methods. <!-- TODO: what about HEAD? -->
+
+Typically, these will be `.js` or `.ts` files depending on your project. Like pages, only one handler may exist for any served path. A handler should export functions
 
 <details>
   <summary>More Info</summary>
   
-  - Valid exports are: `get`, `post`, `put`, `del`.
-  - Each method takes a `context` and `next` argument and should return a WHATWG response either synchronously or asynchronously.
-  - The `context` argument contains the WHATWG request object, path parameters, URL and route meta data.
-  - The `next` argument will call the page for get requests where applicable or return a 204 response.
-
-  ```ts
-  export function post(context, next) {
+  - Valid exports are functions named `GET`, `POST`, `PUT`, or `DELETE`.
+  - Exports can be one of the following
+    - Handler function (see below)
+    - Array of handler functions - will be composed by calling them in order
+    - Promise that resolves to a handler function or array of handler functions 
+  - Handler functions are synchronous or asynchronous functions that
+    - Receives a `context` and `next` argument,
+      - The `context` argument contains the WHATWG request object, path parameters, URL, and route metadata.
+      - The `next` argument will call the page for get requests where applicable or return a `204` response.
+    - Return a WHATWG response, throw a WHATWG response, return undefined. If the function return's undefined the `next` argument with be automatically called and used as the response.
+
+  ```js
+  export function POST(context, next) {
     const { request, params, url, meta } = context;
-    return new Response('updated', { status: 200 });
+    return new Response('Successfully updated', { status: 200 });
   }
 
-  export function put(context, next) {
-    return new Response('created', { status: 201 }); // handle the request
+  export function PUT(context, next) {
+    // `next` will be called for you by the runtime
   }
 
-  export function get(context, next) {
-    return next(); // Call the next handler
+  export async function GET(context, next) {
+    // do something before calling `next`
+    const response = await next();
+    // do something with the response from `next`
+    return response;
   }
 
-  export function del(context, next) {
-    return new Response('removed', { status: 204 });
+  export function DELETE(context, next) {
+    return new Response('Successfully removed', { status: 204 });
   }
   ```
 </details>
 
 
-#### `+middlware.*`
-These files are analagous to layouts for handlers. Middlware get called before handlers and let you perform arbitrary work before and after. Unlike handlers, middleware run for all HTTP verbs.
+#### `+middleware.*`
+
+These files are like layouts, but for handlers. Middleware get called before handlers and let you perform arbitrary work before and after.
+
+> **Note**: Unlike handlers, middleware run for all HTTP methods.
 
 <details>
   <summary>More Info</summary>
   
-  - Expects default export that takes a `context` and `next` argument and should return a WHATWG response either synchronously or asynchronously.
-  - The `context` argument contains the WHATWG request object, path parameters, URL and route meta data.
-  - The `next` argument will call the next middleware, handler or page as applicable for the route.
+  - Expects a `default` export that can be one of the following
+    - Handler function (see below)
+    - Array of handler functions - will be composed by calling them in order
+    - Promise that resolves to a handler function or array of handler functions 
+  - Handler functions are synchronous or asynchronous functions that
+    - Receives a `context` and `next` argument,
+      - The `context` argument contains the WHATWG request object, path parameters, URL, and route metadata.
+      - The `next` argument will call the page for get requests where applicable or return a `204` response.
+    - Return a WHATWG response, throw a WHATWG response, return undefined. If the function return's undefined the `next` argument with be automatically called and used as the response.
 
   ```ts
   export default async function(context, next) {
-    const requestName = `${ctx.request.method} ${ctx.url.href}`;
+    const requestName = `${context.request.method} ${context.url.href}`;
     let success = true;
     console.log(`${requestName} request started`)
     try {
-      return await next(); // wait for subsequent middleware/handler/page
+      return await next(); // Wait for subsequent middleware, handler and page
     } catch (err) {
       success = false;
       throw err;
@@ -176,55 +201,80 @@ These files are analagous to layouts for handlers. Middlware get called before h
 </details>
 
 #### `+meta.*`
-These files represent some meta data to attach to the route. This meta data will be automatically imported by the router and provided on the the route context when invoking a route. 
+
+These files represent static metadata to attach to the route. This metadata will be automatically provided on the the route `context` when invoking a route.
 
 ### Special Files
 
-In addition to the files above which can be defined in any directory under the _routes directory_, there are some special files which can only be defined within the _routes directory_:
+In addition to the files above which can be defined in any directory under the _routes directory_, there are some special files which can only be defined at the top-level of the _routes directory_. <!-- TODO: do we want to keep this restriction? Having nested 404s would be handy for disambiguating things like “there’s no user with that name” or “that promotion wasn’t found, it may have expired” -->
+
+These special pages are subject to a root layout file (`pages/+layout.marko` in the default configuration).
 
 #### `+404.marko`
-This is a special page wich will be rendered for any request whose `Accept` header includes `text/html` if no other handler or page handled the request. This page will be subject to the root layout file (ie. +layout.marko file in the _routes directory_). Responses with this page will have a `404` status code.
+
+This special page responds to any request where:
+
+- The `Accept` request header includes `text/html`
+- *And* no other handler or page rendered the request
+
+Responses with this page will have a `404` status code.
 
 #### `+500.marko`
-This is a special page wich will be rendered for any request whose `Accept` header includes `text/html` if an uncaught error occurs while handling the request. This page will be subject to the root layout file (ie. +layout.marko file in the _routes directory_). Responses with this page will have a `500` status code.
 
+This special page responds to any request where:
+
+- The `Accept` request header includes `text/html`
+- *And* an uncaught error occurs while serving the request
+
+Responses with this page will have a `500` status code.
 
 ### Execution Order
 
-For a matched route the routable files execute in the following order
+Given the following routes directory structure
+
+<pre>
+routes/
+  about/
+    +handler.js
+    +layout.marko
+    +middleware.js
+    +page.marko
+  +layout.marko
+  +middleware.js
+  +page.marko
+</pre>
+
+When the path `"/about"` is requested, the routable files execute in the following order:
+
 1. Middlewares from root-most to leaf-most
 2. Handler
 3. Layouts from root-most to leaf-most
 4. Page
 
-<details>
-  <summary>Diagram</summary>
-
 ```mermaid
 sequenceDiagram
-    participant Middleware1
-    participant Middleware2
-    participant Handler
-    participant Layout1
-    participant Layout2
-    participant Page
-    Note over Layout1,Page: Combined at build-time as a single component
-    Middleware1->>Middleware2: next()
-    Middleware2->>Handler: next()
-    Handler->>Layout1: next()
-    Layout1->Layout2: ${input.renderBody}
-    Layout2->Page: ${input.renderBody}
-    Layout1-->>Handler: Stream Response
-    Handler-->>Middleware2: Response
-    Middleware2-->>Middleware1: Response
+    participant MW1 as routes/+middleware.js
+    participant MW2 as routes/about/+middleware.js
+    participant H as routes/about/+handler.js
+    participant L1 as routes/+layout.marko
+    participant L2 as routes/about/+layout.marko
+    participant P as routes/about/+page.marko
+    Note over L1,P: Combined at build-time as a single component
+    MW1->>MW2: next()
+    MW2->>H: next()
+    H->>L1: next()
+    L1->L2: ${input.renderBody}
+    L2->P: ${input.renderBody}
+    L1-->>H: Stream Response
+    H-->>MW2: Response
+    MW2-->>MW1: Response
 ```
-</details>
 
 ### Path Structure
 
-Within the _routes directory_ the directory structure will determine the path the route will be served. There are four types of directory names:
+Within the _routes directory_, the directory structure will determine the path the route will be served. There are four types of directory names: static, pathless, dynamic, and catch-all.
 
-- **Static directories** - The most common type of directory. Each static directory will contribute its name as a segment in the route's served path like a traditional file server. This is the default and unless the directory matches the requirements for one of the below types, it will be a static directory.
+1. **Static directories** - The most common type. Each static directory contributes its name as a segment in the route's served path, like a traditional fileserver. Unless a directory name matches the requirements for one of the below types, it defaults to a static directory.
 
   Examples:
   ```
@@ -233,16 +283,15 @@ Within the _routes directory_ the directory structure will determine the path th
   /projects
   ```
 
-- **Pathless directories** - These directories do not contribute their name to the route's served path. Directory names that start with an underscore ('_') as well as directories named 'index' will be a pathless directory.
+2. **Pathless directories** - These directories do **not** contribute their name to the route's served path. Directory names that start with an underscore (`_`) will be a pathless directory.
 
   Examples:
   ```
   /_users
   /_public
-  /index
   ```
 
-- **Dynamic directories** - These directories introduce a dynamic parameter to the route's served path and will match any value at that segment. Any directory name that starts with a single dollar sign ('\$') will be a dynamic directory and the remaining directory name will be the parameter at runtime. In the case the directory name is '$', the parameter will not exist at runtime but will be matched.
+3. **Dynamic directories** - These directories introduce a dynamic parameter to the route's served path and will match any value at that segment. Any directory name that starts with a single dollar sign (`$`) will be a dynamic directory, and the remaining directory name will be the parameter at runtime. If the directory name is exactly `$`, the parameter will not be captured but it will be matched.
 
   Examples:
   ```
@@ -251,9 +300,9 @@ Within the _routes directory_ the directory structure will determine the path th
   /$
   ```
 
-- **Catcha-all directories** - These directories are similar to dynamic directories and introduce a dynamic parameter but instead of matching a single sement of the path, they match to the end of the path. Any directory that starts with two dollar signs ('\$\$') will be a catch-all directory and the remaining directory name will be the parameter at runtime. In the case of a directory name '$$', the parameter name at runtime will be '*'. Catch-all directories can be used to make not found/404 routes at any level including the root.
+4. **Catch-all directories** - These directories are similar to dynamic directories and introduce a dynamic parameter, but instead of matching a single path segment, they match to the end of the path. Any directory that starts with two dollar signs (`$$`) will be a catch-all directory, and the remaining directory name will be the parameter at runtime. In the case of a directory named `$$`, the parameter name will not be captured but it will match. Catch-all directories can be used to make `404` Not Found routes at any level, including the root.
 
-  Because catch-all directories always match and consume all the remaining path, you cannot have nested routes within and no further directories will be traversed.
+  Because catch-all directories match any path segment and consume the rest of the path, you cannot nest route files in them and no further directories will be traversed.
 
   Examples:
   ```
@@ -262,6 +311,211 @@ Within the _routes directory_ the directory structure will determine the path th
   /$$
   ```
 
-### Match Ranking
+<!-- ### Match Ranking
+
+*TODO: Write some things* -->
+
+
+
+
+## Vite Plugin
+
+This package’s Vite plugin discovers your route files, generates the routing code, and registers the `@marko/vite` plugin to compile your `.marko` files.
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import marko from "@marko/run/vite"; // Import the Vite plugin
+
+export default defineConfig({
+  plugins: [marko()] // Register the Vite plugin
+})
+```
+
+### Adapters
+
+Adapters provide the means to change the development, build and preview process to fit different deployment platforms and runtimes while allowing authors to write idiomatic code.
+
+Specify your adapter in the Vite config when registering the `@marko/run` plugin
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import marko from "@marko/run/vite";
+import netlify from "@marko/run-adapter-netlify" // Import the adapter
+
+export default defineConfig({
+  plugins: [marko({
+    adapter: netlify({ edge: true }) // Configure and apply the adapter
+  })]
+})
+```
+
+#### Available Adapters
+
+- [@marko/run-adapter-node](https://github.com/marko-js/run/blob/main/packages/adapters/node/README.md)
+- [@marko/run-adapter-netlify](https://github.com/marko-js/run/blob/main/packages/adapters/netlify/README.md)
+- [@marko/run-adapter-static](https://github.com/marko-js/run/blob/main/packages/adapters/static/README.md)
+
+## Runtime
+
+Generally, when using an adapter, this runtime will be abstracted away.
+
+<!-- TODO: Add examples -->
+<!-- TODO: Split fetch and match + invoke in two sections and explain why you might use one or the other  -->
+
+```ts
+import * as Run from '@marko/run/router`;
+```
+
+### Emdedding in Existing Server
+
+
+
+### `Run.fetch`
+
+```ts
+async function fetch<T>(request: Request, platform: T) => Promise<Response | void>;
+```
+
+
+
+This asynchronous function takes a [WHATWG `Request` object](https://fetch.spec.whatwg.org/#request-class) object and an object containing any platform specific data you may want access to and returns the [WHATWG `Response` object](https://fetch.spec.whatwg.org/#response-class) from executing any matched route files or undefined if the request was explicitly not handled. If no route matches the requested path, a `404` status code response will be returned. If an error occurs a `500` status code response will be returned.
+
+Express example:
+```ts
+import express from "express";
+import * as Run from "@marko/run/router";
+
+express()
+  .use(async (req, res, next) => {
+    const request = // ...code to create a WHATWG Request from `req`
+
+    const response = await Run.fetch(request, {
+      req,
+      res
+    });
+
+    if (response) {
+      // ...code to apply response to `res`
+    } else {
+      next();
+    }
+  })
+  .listen(3000);
+```
+
+
+### Other APIs
+
+In some cases you might want more control over when route matching and invokation (creating a response) occur. For instance you may have middleware in your server which need to know if there is a matched route. The runtime provides these additional methods
+
+### `Run.match`
+
+```ts
+interface interface Route {
+  params: Record<string, string>;
+  meta: unknown;
+}
+
+function match(method: string, pathname: string) => Route | null;
+```
+
+This synchronous function takes an HTTP method and path name, then returns an object representing the best match — or `null` if no match is found.
+
+- `params` - a `{ key: value }` collection of any path parameters for the route
+- `meta` - metadata for the route
+
+### `Run.invoke`
+
+```ts
+async function invoke(route: Route, request: Request, platform: any) => Promise<Response | void>;
+```
+This asynchronous function takes a route object returned by [Run.match](#Run.match) the request and platform data and returns a response in the same way the [Run.fetch](#Run.fetch) does.
+
+Express example:
+```ts
+import express from "express";
+import * as Run from "@marko/run/router";
+
+express()
+  .use((req, res) => {
+    const matchedRoute = Run.match(req.method, req.path);
+    if (matchedRoute) {
+      req.match = matchedRoute;
+    }
+  })
+
+  // ...other middleware
+
+  .use(async (req, res, next) => {
+    // Check if a route was previously matched
+    if (!req.match) {
+      next();
+      return;
+    }
+
+    const request = // ...code to create a WHATWG Request from `req`
+    const response = await Run.invoke(req.match, request, {
+      req,
+      res
+    });
+
+    if (response) {
+      // ...code to apply response to `res`
+    } else {
+      next();
+    }
+  })
+  .listen(3000);
+```
+
+
+
+## TypeScript
+
+
+### Global Namespace
+marko/run provides a global namespace `MarkoRun` with the folling types:
+
+**`MarkoRun.Handler`** - Type that represents a handler function to be exported by a +handler or +middleware file
+
+**`MarkoRun.CurrentRoute`** - Type of the route's params and meta data
+
+**`MarkoRun.CurrentContext`** - Type of the request context object in a handler and `out.global` in your Marko files
+
+
+### Generated Types
+If a [TSConfig](https://www.typescriptlang.org/tsconfig) file is discovered in the project root, the Vite plugin will automatically generate a .d.ts file which provides more specific types for each of your middleware, handlers, layouts and pages. This file will be generated at `.marko-run/routes.d.ts` whenever the project is built - including dev.
+> **Note** TypeScript will not include this file by default. If you are not using the [Marko VSCode plugin](https://marketplace.visualstudio.com/items?itemName=Marko-JS.marko-vscode) and you will need to [add it in your tsconfig](https://www.typescriptlang.org/tsconfig#include).
+
+These types are replaced with more specific versions per routeable file:
+
+**`MarkoRun.Handler`**
+- Overrides context with specific MarkoRun.CurrentContext
+
+**`MarkoRun.CurrentRoute`**
+- Adds specific parameters and meta types 
+- In middleware and layouts which are used in many routes, this type will be a union of all possible routes that file will see
+
+**`MarkoRun.CurrentContext`**
+- In middleware and layouts which are used in many routes, this type will be a union of all possible routes that file will see.
+- When an adapter is used, it can provide types for the platform
+
+## Beta Roadmap
+
+- Error handling
+- Error component
+- Redirect component
+
+## What about @marko/serve?
+
+Once stable @marko/run will replace @marko/serve and improves upon that project in several critical ways.
+
+1. Special "route files" (eg `+page.marko`) improve the developer ergonomics quite substantially. While they may cause a double take initially, making these explicit allows colocating additional components, tests, stories, config, utilities and whatever else you need along side the page components. With `@marko/serve` it was far to easy to "accidentally" serve some of your test fixtures :see-no-evil:.
+2. @marko/serve was built around Webpack. Since Webpack doesn't have great support for SSR'd apps it meant that a lot of this work was up to us. This was not only a maintenance burden but also lead to some rough edges such as no HMR support (just full page reloading in dev). By switching to Vite with first class SSR support things all come together much more smoothly. And we're in good company (LINK TO OTHER META FRAMEWORKS ON VITE)!
+3. @marko/serve was primarily designed with a node target in mind. @marko/run instead supports an "adaptor" model, where you can author in web standard apis and build your application to run in Node, Deno, Netlify, Cloudflare and even a static site.
+4. The programatic api of `@marko/serve` left some to be desired which made it difficult to integrate into existing development servers and projects. Because of this public facing eBay applications (The largest consumer of Marko) we're note able to bring in `@marko/serve`. With `@marko/run` we've worked from the ground up to ensure a flexible enough programatic api to allow embedding in existing complex applications. Because of this we're confident that `@marko/run` will see much more use than `@marko/serve` and more investment from us!
+5. Built in layout management. Strictly speaking Marko does not need the concept of `+layout.marko` "route file". If you've used Marko before you know it's very easy to treat layouts as normal components. But by bringing these layouts into the router we're able to reduce the amount of JavaScript naively sent to the browser, reduce the amount of boilerplate, and prime ourselves for some plans we have post Marko 6 :eyes:.
 
-*TODO: Write some things*
+There's more of course, but we're committed to make `@marko/run` _the best way_ to build a Marko application.