jam 0.9.2 → 0.9.3

package/README.md

@@ -1,62 +1,63 @@
 # jam
 
-`jam` is an application server for isolated JavaScript. It runs JavaScript (and TypeScript) per request with isolated execution contexts, inspired by the PHP-FPM model.
+`jam` serves JavaScript and TypeScript files as HTTP routes with isolated per-request execution.
 
 ## Usage
 
-```bash
+```sh
 jam [flags] [scripts-dir]
 ```
 
-Run `jam --help` for all options:
-
-```text
-Options:
-  --port <port>                            TCP port to listen on.
-  --host <host>                            Host or IP address to bind the TCP server to.
-  --unix <path>                            Unix socket path to listen on instead of TCP.
-  --php                                    Enable PHP-style globals such as $_GET, $_POST, and $_SERVER.
-  --public <dir>                           Directory for static files (checked before script routes).
-  --access-log                             Enable per-request access log output.
-  --config <path>                          Path to jamconfig.json (default: ./jamconfig.json).
-  --env <KEY=VALUE>                        Set an env var for scripts; include multiple times.
-  --log <path|->                           Log destination ('-' for stdout, otherwise a file path).
-  --log-level <error|warning|info|debug>   Minimum log level to emit (default: info).
-  --tls-cert <path>                        Path to TLS certificate PEM file.
-  --tls-key <path>                         Path to TLS private key PEM file.
-  --timeout-ms <ms>                        Maximum script execution time in milliseconds.
-  --request-max-body-bytes <bytes>         Maximum allowed request body size in bytes.
-  --request-max-header-bytes <bytes>       Maximum allowed request header size in bytes.
-  --workers <count>                        Worker pool size (0 uses automatic sizing).
-  --worker-memory-mb <mb>                  Per-worker memory limit in MB.
-  --worker-max-requests <count>            Recycle a worker after this many requests.
-  --mode <value>                           Runtime mode string (commonly production or development).
-  --error-page-404 <path>                  Path to a custom 404 error page.
-  --error-page-500 <path>                  Path to a custom 500 error page.
-  --help                                   Print this help message and exit.
-  --version                                Print version and exit.
-
-Examples:
-  jam
-  jam --port 3000
-  jam ./app
-  jam --php --public ./public ./app
+## Common Commands
+
+```sh
+# Serve scripts from ./scripts on port 3000
+jam ./scripts
+
+# Development mode with detailed error pages
+jam --mode development ./scripts
+
+# Use a config file
+jam --config ./jamconfig.json ./scripts
+
+# Enable PHP-style globals
+jam --php ./scripts
+```
+
+For the complete CLI surface, run:
+
+```sh
+jam --help
+```
+
+## Minimal Script
+
+```ts
+export default {
+  fetch() {
+    return new Response("Hello from Jam");
+  }
+};
 ```
 
-Warning and error messages are written to stderr, while info/debug messages are written to stdout when logging to stdout.
-When stderr is an interactive terminal, warning output is yellow and error output is red.
-Set `NO_COLOR` in the environment to force no colors.
+Saved as `scripts/app.ts`, this route is available at `/app`.
+
+## Docs
+
+- [Introduction](../../docs/001-introduction.md)
+- [Getting Started](../../docs/002-getting-started.md)
+- [Build a Real App](../../docs/003-writing-scripts.md)
+- [Configuration](../../docs/004-configuration.md)
+- [Runtime APIs](../../docs/005-runtime-apis.md)
+- [Templates](../../docs/006-templates.md)
+- [Deployment](../../docs/007-deployment.md)
 
 ## Development
 
 `jam` has two entry points with different roles:
 
-- `bin/jam.js`: Node-facing dispatch shim for the npm package.
-  - This is what `npx jam` and `npm/yarn/pnpm` bin resolution executes.
-  - It picks the correct platform package (`jam-darwin-arm64`, `jam-darwin-x64`, `jam-linux-arm64`, `jam-linux-x64`), installs it if needed, and forwards execution to its binary.
-- `src/entry.ts`: Bun runtime CLI entrypoint.
-  - This is what gets compiled into each platform binary.
-  - It should remain minimal and primarily call into `main` from `src/main.ts`.
-  - CI and release scripts build it for each target.
+- `bin/jam.js`: Node-facing dispatch shim for npm usage.
+- `src/entry.ts`: Bun runtime CLI entrypoint compiled into platform binaries.
 
-The fallback path used in `bin/jam.js` (`../src/entry.ts`) is for local development when running from a checked out repo and the platform package binary is unavailable.
+For repeatable runtime engineering workflows, see the repo-local skills index:
+[`../../skills/README.md`](../../skills/README.md).

package/bin/jam.js

@@ -11,7 +11,7 @@
 // If the platform package is not installed yet, this shim tries to install it
 // on demand via `npm install <platform-package>@<version> --no-save`.
 // If Bun is available in a local repo checkout and no platform package is
-// present, it falls back to running `src/main.ts` directly for development.
+// present, it falls back to running `src/entry.ts` directly for development.
 //
 // `src/entry.ts` is the Bun source entrypoint used by platform package builds;
 // this file (`jam.js`) is the runtime dispatcher that selects and runs them.

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "jam",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "description": "An application server for isolated JavaScript",
   "license": "MIT",
+  "author": "Michael Jackson <mjijackson@gmail.com>",
   "type": "module",
   "types": "types/index.d.ts",
   "repository": {
@@ -28,10 +29,10 @@
     ]
   },
   "optionalDependencies": {
-    "jam-darwin-arm64": "0.9.2",
-    "jam-darwin-x64": "0.9.2",
-    "jam-linux-arm64": "0.9.2",
-    "jam-linux-x64": "0.9.2"
+    "jam-darwin-arm64": "0.9.3",
+    "jam-darwin-x64": "0.9.3",
+    "jam-linux-arm64": "0.9.3",
+    "jam-linux-x64": "0.9.3"
   },
   "dependencies": {
     "@jridgewell/trace-mapping": "^0.3.31",