@weft-js/start 0.1.0 → 0.1.2

package/README.md

@@ -1,8 +1,8 @@
 # @weft-js/start
 
-> **Early release (0.1.0).** APIs will change between minor versions.
+> **Early release (0.1.x).** APIs can change between minor versions.
 
-The full-stack part of weft: routes from files, server functions, server rendering with streaming, a database, auth and
+The full-stack part of Weft: routes from files, server functions, server rendering with streaming, a database, auth and
 realtime. It runs on Node, Bun or Deno, and doesn't need Rust. An app made with `npm create @weft-js` already has it.
 
 ```bash
@@ -15,7 +15,12 @@ A server function in `src/server/` runs on the server. The client gets a stub th
 // src/server/greeting.ts
 import { query } from '@weft-js/start'
 
-export const greeting = query({ run: () => `Hello at ${new Date().toISOString()}` })
+export const greeting = query({
+  run: () => {
+    const time = new Date().toISOString()
+    return `Hello at ${time}`
+  },
+})
 ```
 
 A route in `src/routes/` reads it. Calling the query in a component gives a `Resource`, a box that fills when the data
@@ -33,6 +38,20 @@ export default function Hello() {
 
 `npx weft dev` serves it at `/hello`.
 
+## What you get
+
+- **Routes from files.** `src/routes/shop/[id].tsx` is `/shop/:id`, with `_layout.tsx` for layouts, `load` for a page's
+  data, `notFound()` and `redirect()`, and `meta` for titles, descriptions and share cards.
+- **Server functions.** `query` and `mutation` validate their input with a schema, run with `ctx` (the request, the
+  user, the database) and come back typed. Mutations name the tags they invalidate, and `optimistic` updates the page
+  before the server answers. Forms post to them without JavaScript.
+- **Streaming SSR and hydration**, with `<Boundary>` sending each part when its data is ready.
+- **A database.** `ctx.db` over Drizzle, Prisma or plain SQL (`@weft-js/db`) on SQLite, Postgres or MySQL. `weft db generate`
+  writes the migration, which applies on the next request.
+- **Auth** through Better Auth or your own, with `ctx.user` in every server function.
+- **Live data.** A page that reads a table updates when another user changes it, from the database's change feed.
+- **Any runtime.** `weft build` targets Node, Bun or Deno, or a host preset (Netlify, Vercel, Cloudflare, Fly, Render).
+
 ## Docs
 
 - `weft docs start`: routes, `load`, `query`, `mutation`, the database, auth, runtimes and realtime.
@@ -40,3 +59,17 @@ export default function Hello() {
 - `weft docs rust`: server functions with a Rust body, if you want them.
 
 The source of each page is in [packages/cli/docs](../cli/docs).
+
+## End-to-end tests
+
+From the repository, `pnpm --filter @weft-js/start test:e2e <built-app>` runs the runtime matrix.
+Pass `--e2e <path>` to select another scenario in `test/e2e`. The live database scripts in that
+folder run directly with Node and require the database environment shown in each script. They keep
+`.mjs` because Node and the runtime matrix load them without a test transform.
+
+## Links
+
+- [Source](https://github.com/Ravonus/weft/tree/main/packages/start)
+- [Weft on GitHub](https://github.com/Ravonus/weft): the framework, the docs and every package
+- [Changelog](https://github.com/Ravonus/weft/blob/main/CHANGELOG.md)
+- [Issues](https://github.com/Ravonus/weft/issues)