Actually build the thing in CI

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: ci
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: sqlc-dev/setup-sqlc@v4
+      with:
+        sqlc-version: '1.24.0'
+    - uses: actions/setup-node@v4
+    - run: wget https://github.com/bytecodealliance/javy/releases/download/v1.2.0/javy-x86_64-linux-v1.2.0.gz
+    - run: tar -xvf javy-x86_64-linux-v1.2.0.gz
+    - run: npm install
+    - run: npx tsc --noEmit
+	  - run: npx esbuild --bundle src/app.ts --tree-shaking=true --format=esm --target=es2020 --outfile=out.js
+	  - run: ./javy compile out.js -o examples/plugin.wasm
+	  - run: sqlc diff
+      working-directory: examples

README.md

@@ -31,6 +31,222 @@ sql:
 
 ## Getting started
 
+# Getting started with PostgreSQL
+
+This tutorial assumes that the latest version of sqlc is
+[installed](https://docs.sqlc.dev/en/latest/overview/install.html) and ready to use.
+
+We'll generate TypeScript here, but other [language
+plugins](https://docs.sqlc.dev/en/latest/reference/language-support.html) are
+available. You'll need Bun (or Node.js) installed if you want to build and run a
+program with the code sqlc generates, but sqlc itself has no dependencies.
+
+We'll also rely on sqlc's [managed databases](https://docs.sqlc.dev/en/latest/howto/managed-databases.html),
+which require a sqlc Cloud project and auth token. You can get those from
+the [sqlc Cloud dashboard](https://dashboard.sqlc.dev/). Managed databases are
+an optional feature that improves sqlc's query analysis in many cases, but you
+can turn it off simply by removing the `cloud` and `database` sections of your
+configuration.
+
+## Setting up
+
+Create a new directory called `sqlc-tutorial` and open it up.
+
+Initialize a new package.
+
+```shell
+bun init
+```
+
+sqlc looks for either a `sqlc.(yaml|yml)` or `sqlc.json` file in the current
+directory. In our new directory, create a file named `sqlc.yaml` with the
+following contents:
+
+```yaml
+version: "2"
+cloud:
+  # Replace <PROJECT_ID> with your project ID from the sqlc Cloud dashboard
+  project: "<PROJECT_ID>"
+plugins:
+- name: ts
+  wasm:
+    url: https://downloads.sqlc.dev/plugin/sqlc-gen-typescript_0.1.0.wasm
+    sha256: TODO
+sql:
+  - engine: "postgresql"
+    queries: "query.sql"
+    schema: "schema.sql"
+    database:
+      managed: true
+  - out: src/authors
+    plugin: ts
+    options:
+      runtime: node
+      driver: pg
+```
+
+Replace `<PROJECT_ID>` with your project ID from the sqlc Cloud dashboard. It
+will look something like `01HA8SZH31HKYE9RR3N3N3TSJM`.
+
+And finally, set the `SQLC_AUTH_TOKEN` environment variable:
+
+```shell
+export SQLC_AUTH_TOKEN="<your sqlc auth token>"
+```
+
+## Schema and queries
+
+sqlc needs to know your database schema and queries in order to generate code.
+In the same directory, create a file named `schema.sql` with the following
+content:
+
+```sql
+CREATE TABLE authors (
+  id   BIGSERIAL PRIMARY KEY,
+  name text      NOT NULL,
+  bio  text
+);
+```
+
+Next, create a `query.sql` file with the following five queries:
+
+```sql
+-- name: GetAuthor :one
+SELECT * FROM authors
+WHERE id = $1 LIMIT 1;
+
+-- name: ListAuthors :many
+SELECT * FROM authors
+ORDER BY name;
+
+-- name: CreateAuthor :one
+INSERT INTO authors (
+  name, bio
+) VALUES (
+  $1, $2
+)
+RETURNING *;
+
+-- name: UpdateAuthor :exec
+UPDATE authors
+  set name = $2,
+  bio = $3
+WHERE id = $1;
+
+-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = $1;
+```
+
+If you prefer, you can alter the `UpdateAuthor` query to return the updated
+record:
+
+```sql
+-- name: UpdateAuthor :one
+UPDATE authors
+  set name = $2,
+  bio = $3
+WHERE id = $1
+RETURNING *;
+```
+
+## Generating code
+
+You are now ready to generate code. You shouldn't see any output when you run
+the `generate` subcommand, unless something goes wrong:
+
+```shell
+sqlc generate
+```
+
+You should now have a `tutorial` subdirectory with three files containing Go
+source code. These files comprise a Go package named `tutorial`:
+
+```
+├── package.json
+├── query.sql
+├── schema.sql
+├── sqlc.yaml
+└── src/authors
+    ├── query_sql.ts
+```
+
+## Using generated code
+
+You can use your newly-generated code package from any TypeScript program.
+Create a file named `src/main.ts` and add the following contents:
+
+```ts
+import postgres from "postgres";
+
+import {
+  createAuthor,
+  deleteAuthor,
+  getAuthor,
+  listAuthors,
+} from "./authors/query_sql";
+
+async function main() {
+  const sql = postgres(process.env["DATABASE_URL"] ?? "");
+
+  // Create an author
+  const author = await createAuthor(sql, {
+    name: "Seal",
+    bio: "Kissed from a rose",
+  });
+  if (author === null) {
+    throw new Error("author not created");
+  }
+  console.log(author);
+
+  // List the authors
+  const authors = await listAuthors(sql);
+  console.log(authors);
+
+  // Get that author
+  const seal = await getAuthor(sql, { id: author.id });
+  if (seal === null) {
+    throw new Error("seal not found");
+  }
+  console.log(seal);
+
+  // Delete the author
+  await deleteAuthor(sql, { id: seal.id });
+}
+
+(async () => {
+  await main();
+})();
+```
+
+Before this code will run you'll need to install the `pg` package:
+
+```shell
+$ bun install pg
+```
+
+The program should compile without errors. To make that possible, sqlc generates
+readable, **idiomatic** TypeScript code that you otherwise would've had to write
+yourself. Take a look in `src/authors/query_sql.ts`.
+
+Of course for this program to run successfully you'll need to run after setting
+the `DATABASE_URL` environment variable. And your database must have the
+`authors` table as defined in `schema.sql`.
+
+```shell
+$ DATABASE_URL="$(sqlc createdb)" bun run src/main.ts
+```
+
+```shell
+$ bun run src/main.ts
+```
+
+You should now have a working program using sqlc's generated TypeScript source
+code, and hopefully can see how you'd use sqlc in your own real-world
+applications.
+
+## Configuration
+
 ### PostgreSQL and node-postgres
 
 ```yaml