create-shape-app 0.1.6 → 0.1.7
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 +3 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,33 +4,9 @@ CLI for scaffolding Shape apps from the Builder Kit template pinned to release t
|
|
|
4
4
|
|
|
5
5
|
## Quick Start
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
bun run type-check
|
|
11
|
-
bun run lint
|
|
12
|
-
bun run contracts:compile
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
Equivalent commands:
|
|
16
|
-
- `npm create shape-app@latest my-app -- --yes`
|
|
17
|
-
- `pnpm dlx create-shape-app my-app --yes`
|
|
18
|
-
- `yarn create shape-app my-app --yes`
|
|
19
|
-
|
|
20
|
-
## CLI Usage
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
create-shape-app [project-name] [options]
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
Options:
|
|
27
|
-
- `-y, --yes`
|
|
28
|
-
- `--pm <bun|npm|pnpm|yarn>`
|
|
29
|
-
- `--skip-install`
|
|
30
|
-
- `--skip-git`
|
|
31
|
-
- `--template-ref <tag>`
|
|
32
|
-
- `-h, --help`
|
|
33
|
-
- `-v, --version`
|
|
7
|
+
Choose one:
|
|
8
|
+
- `npx create-shape-app`
|
|
9
|
+
- `bunx create-shape-app`
|
|
34
10
|
|
|
35
11
|
## Behavior
|
|
36
12
|
- Scaffolds from `shape-network/builder-kit` release tags only (`latest` by default).
|
|
@@ -61,9 +37,6 @@ bun run type-check
|
|
|
61
37
|
bun run test
|
|
62
38
|
```
|
|
63
39
|
|
|
64
|
-
Builder Kit README quickstart update snippet is tracked in:
|
|
65
|
-
- `docs/builder-kit-quickstart.md`
|
|
66
|
-
|
|
67
40
|
## Publish
|
|
68
41
|
- Trigger: GitHub release publish event.
|
|
69
42
|
- Guard: workflow checks release tag matches `package.json` version.
|