shipstatic 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
# shipstatic
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**The package you're looking for is [`@shipstatic/ship`](https://www.npmjs.com/package/@shipstatic/ship).** That's where the code lives, and where the full documentation is.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
This package is an alias for it. It exists as an escape hatch: people and agents reach for the unscoped name first, and a good guess shouldn't dead-end in a 404.
|
|
6
|
+
|
|
7
|
+
**Use this one directly — there's nothing to switch to.** `npx shipstatic ./dist` runs the same binary as `npx @shipstatic/ship ./dist`, and `import Ship from 'shipstatic'` resolves to the same module as `import Ship from '@shipstatic/ship'`. Not a redirect, not a shim with its own behaviour — the same package under a shorter name. If you've read this far and you're about to type `npx`, just type it.
|
|
6
8
|
|
|
7
9
|
## Deploy in seconds — no install, no account
|
|
8
10
|
|
|
11
|
+
Put a static site, landing page, or prototype online:
|
|
12
|
+
|
|
9
13
|
```bash
|
|
10
14
|
npx shipstatic ./dist
|
|
11
15
|
```
|
|
@@ -72,18 +76,11 @@ const result = await ship.deploy('./dist');
|
|
|
72
76
|
// result.claim → visit to keep permanently
|
|
73
77
|
```
|
|
74
78
|
|
|
75
|
-
`shipstatic` and `@shipstatic/ship` resolve to the **same module**, so importing either name gives you the identical class:
|
|
76
|
-
|
|
77
|
-
```javascript
|
|
78
|
-
import Ship from 'shipstatic'; // these are
|
|
79
|
-
import Ship from '@shipstatic/ship'; // the same thing
|
|
80
|
-
```
|
|
81
|
-
|
|
82
79
|
## Everything else
|
|
83
80
|
|
|
84
81
|
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)**.
|
|
85
82
|
|
|
86
|
-
This README
|
|
83
|
+
This README covers only the quickstart, deliberately. A copy of another package's documentation is a second copy to keep true — and the day it stops being true, it's worse than none.
|
|
87
84
|
|
|
88
85
|
## License
|
|
89
86
|
|
package/package.json
CHANGED