@awsmbiz/create-inbis-app 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# @awsmbiz/create-inbis-app
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Creates a new Inbis app from the platform's app template (a Hono API and React SPA on one
+Cloudflare Worker with D1), with only the modules you pick. The code is yours afterwards:
+there is no template sync.
+
+```sh
+pnpm create @awsmbiz/inbis-app my-app
+```
+
+In a terminal it asks for what the flags leave out. With `--yes`, without a terminal, or with
+`CI` set, it never prompts: missing answers take their defaults, and the directory is required.
+
+| Flag | Answer | Default |
+|---|---|---|
+| `[directory]` | Directory to create (missing or empty) | none |
+| `--name` | App (package.json) name | the directory name |
+| `--worker` | Cloudflare Worker name (`<worker>-staging`, `<worker>-production` when deployed; D1 databases are named after it) | from the app name |
+| `--staging-domain`, `--production-domain` | Custom domain per deployed environment | `staging.<worker>.example.com`, `<worker>.example.com` |
+| `--binding NAME=NEW` | Rename a binding, repeatable (e.g. `DB=APP_DB`) | unchanged |
+| `--modules a,b` / `none` | Modules; the ones they require are added and reported | none (the minimal app) |
+| `--auth-methods a,b` | auth: sign-in methods among `email-password`, `phone-otp`, `totp` (2FA needs email-password; the admin module needs both) | `email-password,totp` |
+| `--registration` | auth: `open`, `invite-only`, `admin-only` (no invitations), `closed`; all but `open` need email-password and totp for administrators | `invite-only` |
+| `--phone-allow`, `--phone-block` | auth with phone-otp: calling-code prefixes that may / never receive codes, comma-separated, or `none` | **none: both required** with phone-otp (asked in a terminal) |
+| `--git` / `--no-git` | `git init` the app | ask; no with `--yes` |
+| `--platform-version` | Version to pin `@awsmbiz/*` packages to | this generator's version (lockstep) |
+
+`--modules-dir <dir>` takes modules from another directory (platform tests). How the template,
+modules and substitution work: `docs/template-modules.md` in the platform repository.