shipstatic 1.1.0 → 1.1.1

package/README.md

@@ -1,6 +1,8 @@
 # shipstatic
 
-CLI and SDK for [ShipStatic](https://shipstatic.com) — deploy static websites, landing pages, and prototypes instantly from the terminal or code.
+Deploy static websites, landing pages, and prototypes instantly — from the terminal or from code.
+
+> **Looking for the main package?** This is the unscoped alias for **[`@shipstatic/ship`](https://www.npmjs.com/package/@shipstatic/ship)** — same CLI, same SDK, shorter name. The full documentation lives there.
 
 ## Deploy in seconds — no install, no account
 
@@ -10,41 +12,78 @@ npx shipstatic ./dist
 
 That's it. Your site is live on `*.shipstatic.com`. No sign-up, no config, no global install. Got Node? You're ready.
 
-The output includes a **claim URL** — visit it to keep the site permanently. Anonymous deployments are public and expire in 3 days.
+A single file works the same way:
 
-```javascript
-import Ship from 'shipstatic';
+```bash
+npx shipstatic ./index.html
+```
 
-const ship = new Ship();
-const result = await ship.deploy('./dist');
-// result.deployment → live URL (happy-cat-abc1234.shipstatic.com)
-// result.claim      → visit to keep permanently
+**What comes back:** the live URL, plus a **claim URL** — visit it to keep the site permanently. Anonymous deployments are **public** and **expire in 3 days**.
+
+## Password-protect a deployment
+
+```bash
+npx shipstatic ./dist --password "correct-horse-battery-staple"
+```
+
+Visitors are prompted before the site is served. Works on a single file too:
+
+```bash
+npx shipstatic ./index.html --password "correct-horse-battery-staple"
 ```
 
+The password can also come from the environment, which keeps it out of your shell history and CI logs:
+
+```bash
+SHIP_PASSWORD="correct-horse-battery-staple" npx shipstatic ./dist
+```
+
+## For scripts and agents
+
+Add `--json` to any command for machine-readable output — on success **and** on failure:
+
+```bash
+npx shipstatic ./dist --json
+```
+
+- **Exit code** is `0` on success, non-zero on failure — branch on it, not on the text.
+- **Errors** are JSON too under `--json`, carrying a stable `error` type and `status`. Branch on those, never on the message string.
+- **`--no-color`** is honoured, and colour is disabled automatically when output is not a TTY.
+- **`SHIP_PASSWORD`** sets `--password` from the environment.
+
+Deploying anonymously needs no credentials at all — which is what makes `npx shipstatic ./dist` safe to run in a sandbox with no secrets configured. Just remember such deployments are public and expire in 3 days; the claim URL in the output is how they become permanent.
+
 ## Install (optional, for repeat use)
 
 ```bash
-npm install -g shipstatic   # global CLI — the `ship` command
+npm install -g shipstatic   # global CLI — provides the `ship` command
 ```
 
-> As a project dependency: `npm install shipstatic`
+> The command is **`ship`**, matching `@shipstatic/ship` exactly. As a project dependency: `npm install shipstatic`.
+
+## Use it as an SDK
 
-## What this package is
+```javascript
+import Ship from 'shipstatic';
 
-`shipstatic` is the unscoped name for [`@shipstatic/ship`](https://www.npmjs.com/package/@shipstatic/ship). It forwards to that package and has **no API of its own** — same CLI, same SDK, shorter name.
+const ship = new Ship();
+const result = await ship.deploy('./dist');
+// result.deployment → live URL
+// result.claim      → visit to keep permanently
+```
 
-The two are interchangeable. Install whichever name you prefer; both resolve to the same implementation, so nothing behaves differently:
+`shipstatic` and `@shipstatic/ship` resolve to the **same module**, so importing either name gives you the identical class:
 
 ```javascript
-import Ship from 'shipstatic';          // these are
-import Ship from '@shipstatic/ship';    // the same thing
+import Ship from 'shipstatic'; // these are
+import Ship from '@shipstatic/ship'; // the same thing
 ```
 
-## Documentation
+## Everything else
 
-Every command, SDK method, authentication mode, and custom-domain flow is documented **once**, in [`@shipstatic/ship`](https://www.npmjs.com/package/@shipstatic/ship).
+Custom domains, API keys, deploy tokens, deployment management, the full SDK reference — all documented once, in **[`@shipstatic/ship`](https://www.npmjs.com/package/@shipstatic/ship)**.
 
-This README deliberately does not restate any of it. A forwarder that copies its target's documentation is just a second copy to keep true — and the day it stops being true, it is worse than no documentation at all.
+This README deliberately covers only the quickstart. A forwarder that copies its target's documentation is just a second copy to keep true — and the day it stops being true, it is worse than no documentation at all.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipstatic",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "CLI and SDK for ShipStatic — deploy static websites, landing pages, and prototypes instantly. The unscoped name for @shipstatic/ship.",
   "keywords": [
     "shipstatic",
@@ -69,5 +69,9 @@
     "@biomejs/biome": "2.5.5",
     "publint": "^0.3.12",
     "vitest": "^4.1.10"
-  }
+  },
+  "bugs": {
+    "url": "https://github.com/shipstatic/ship/issues"
+  },
+  "author": "ShipStatic"
 }