ignotum 0.0.3 → 0.0.5

package/README.md

@@ -3,7 +3,7 @@
 Ignotum is an opinionated TypeScript application cloud. Define a schema, queries, and mutations,
 then call them from the client with end-to-end types and realtime updates.
 
-The current release supports local development. Hosted infrastructure is not included yet.
+The current release supports local development and hosted deployment.
 
 ## Get started
 
@@ -15,15 +15,15 @@ cd my-app
 npx ignotum dev
 ```
 
-Open <http://127.0.0.1:3210>. The generated project contains a schema, a query, a mutation, and a
+Open <http://127.0.0.1:3210>. The generated app contains a schema, a query, a mutation, and a
 JSX client.
 
 ## Follow the example app
 
 ```text
 client/
-  App.tsx
-  styles.css
+  index.tsx
+  icon.svg
 server/
   counter.ts
   schema.ts
@@ -75,6 +75,8 @@ export const get = query({
 });
 
 export const increment = mutation({
+  returns: values.number(),
+
   handler: function* (ctx) {
     const counters = yield* ctx.db.query("counters").collect();
     const counter = counters[0];
@@ -85,6 +87,8 @@ export const increment = mutation({
     } else {
       yield* ctx.db.patch("counters", counter.id, { value });
     }
+
+    return value;
   },
 });
 ```
@@ -100,15 +104,16 @@ and `api.counter.increment`.
 
 ### Call the functions from the client
 
-`client/App.tsx` uses the generated references to call the server functions.
+`client/index.tsx` defines the app title and uses the generated references to call the server
+functions.
 
 ```tsx
-import { Result, useMutation, useQuery } from "ignotum/client";
+import { app, Result, useMutation, useQuery } from "ignotum/client";
 
 import { api } from "@/_generated/api.js";
 import { counterIncrement } from "@/shared/utils.js";
 
-export default function App() {
+function App() {
   const count = useQuery(api.counter.get);
   const increment = useMutation(api.counter.increment);
 
@@ -133,6 +138,11 @@ export default function App() {
     </main>
   );
 }
+
+export default app({
+  title: "Counter",
+  component: App,
+});
 ```
 
 `useQuery` starts with a pending result and subscribes to later values. `Result.match` makes the UI
@@ -142,6 +152,15 @@ server definition.
 Open the app in two browser tabs and increment the counter in either one. Both tabs update because
 Ignotum refreshes active queries after a successful mutation.
 
+Ignotum loads Tailwind CSS automatically. Custom CSS files are ordinary client modules and can use
+any filename when imported from app code.
+
+The optional `client/icon.svg` file becomes the favicon automatically. If it is absent, Ignotum
+does not add a favicon link.
+
+Optional files in a top-level `public` directory keep their relative paths as public URLs. Ignotum
+accepts AVIF, GIF, ICO, JPEG, PNG, WebP, and PDF files there; `client/public` is not supported.
+
 ## Keep working
 
 The dev server watches the schema and server modules, regenerates bindings, and reloads the app.