@xirconsss/zero-mock 0.1.0 → 0.1.1

package/README.md

@@ -2,7 +2,7 @@
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.8-blue?logo=typescript&logoColor=white)](tsconfig.json)
-[![npm version](https://img.shields.io/npm/v/@xircons/zero-mock.svg)](https://www.npmjs.com/package/@xircons/zero-mock)
+[![npm version](https://img.shields.io/npm/v/@xirconsss/zero-mock.svg)](https://www.npmjs.com/package/@xirconsss/zero-mock)
 
 **zero-mock** is a zero-config Node.js CLI that turns a JSON file into a local REST API. Point it at a file whose top-level keys are **collection names** and whose values are **arrays of records**—it serves full CRUD routes and writes changes back to disk. Built for **frontend developers** who need a quick, realistic backend for prototypes, demos, and integration tests without standing up a database or bespoke server.
 
@@ -11,7 +11,7 @@
 ### Global
 
 ```bash
-npm install -g @xircons/zero-mock
+npm install -g @xirconsss/zero-mock
 ```
 
 Run the CLI as **`zero-mock`** (see [Usage](#usage)).
@@ -19,17 +19,17 @@ Run the CLI as **`zero-mock`** (see [Usage](#usage)).
 ### One-off with npx
 
 ```bash
-npx @xircons/zero-mock -f ./data.json -p 3000
+npx @xirconsss/zero-mock -f ./data.json -p 3000
 ```
 
-Flags: **`-f`** / **`--file`** (required JSON path), **`-p`** / **`--port`** (optional, default `3000`). If your shell or npm version forwards extra flags to npm instead of the CLI, insert **`--`** before **`-f`** (e.g. `npx @xircons/zero-mock -- -f ./data.json`).
+Flags: **`-f`** / **`--file`** (required JSON path), **`-p`** / **`--port`** (optional, default `3000`). If your shell or npm version forwards extra flags to npm instead of the CLI, insert **`--`** before **`-f`** (e.g. `npx @xirconsss/zero-mock -- -f ./data.json`).
 
 ## Quick start
 
 From the repo root (or any directory containing the example file):
 
 ```bash
-npx @xircons/zero-mock -f ./example/db.json -p 3000
+npx @xirconsss/zero-mock -f ./example/db.json -p 3000
 ```
 
 In another terminal:
@@ -41,6 +41,10 @@ curl http://localhost:3000/users/1
 
 The server logs the exact URLs for each collection when it starts.
 
+## Development
+
+From a clone: `npm install`, then `npm run build` (or `npm run dev` with `ts-node`). Run the built CLI with `node dist/index.js -f ./example/db.json -p 3000`.
+
 ## Features
 
 - **Zero-config** — one JSON file defines your API surface; no schemas or generators to run.
@@ -67,10 +71,26 @@ Invalid JSON bodies (non-objects for write routes) receive **`400`** with a JSON
 
 The root must be a JSON **object**. Each property must be an **array** (your “tables”). Each item you want to address by URL should include an **`id`** field (number or string).
 
-## License
+## Publishing to npm (maintainers)
+
+1. Use an [npmjs.com](https://www.npmjs.com/) account with **2FA** enabled and permission to publish the **`@xirconsss`** scope (user or org on npm).
+2. Log in locally: `npm login` (or `npm login --auth-type=web`).
+3. Install deps and build: `npm install` (so `tsc` is available), then bump **`version`** in `package.json` when releasing.
+4. Publish: `npm publish` (`publishConfig.access` is already `public` for this scoped package).
+
+**GitHub Actions:** the workflow [`.github/workflows/publish-npm.yml`](.github/workflows/publish-npm.yml) runs on **workflow_dispatch** or when a **GitHub Release** is published. It uses the GitHub **Environment** named **`NPM_TOKEN`** with a secret also named **`NPM_TOKEN`** (repo → **Settings** → **Environments** → **NPM_TOKEN** → **Environment secrets**).
 
-MIT — see [LICENSE](LICENSE).
+**Token on npm (required):**
+
+1. Create a classic **[Automation](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-classic-tokens)** token, **or** a **[granular access token](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-granular-access-tokens)** with **read and write** on **`@xirconsss/zero-mock`** (and org **`xirconsss`** if npm asks).
+2. For granular tokens: turn **Bypass two-factor authentication (2FA)** **on** so CI does not hit **`EOTP`**. Do **not** use **`NPM_OTP`** secrets (codes expire in ~30 seconds).
+3. Paste the token into the **`NPM_TOKEN`** environment secret on GitHub, then run the workflow.
+
+**Optional — OIDC trusted publishing:** You can later move to [npm trusted publishing](https://docs.npmjs.com/trusted-publishers) and drop the secret; if you see **`E404`** on `PUT` with OIDC, the Trusted Publisher settings on npm (repo, workflow filename, environment name) do not match this workflow—token auth avoids that until it is configured correctly.
+
+## License
 
+MIT - see [LICENSE](LICENSE).
 ## Links
 
 - **Repository:** [github.com/xircons/zero-mock](https://github.com/xircons/zero-mock)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xirconsss/zero-mock",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Zero-config CLI that generates REST APIs from JSON files",
   "license": "MIT",
   "keywords": [
@@ -41,6 +41,7 @@
   "bugs": {
     "url": "https://github.com/xircons/zero-mock/issues"
   },
+  "homepage": "https://github.com/xircons/zero-mock#readme",
   "dependencies": {
     "commander": "^13.1.0",
     "cors": "^2.8.5",