Skip to content

Commit 8579210

Browse files
committed
improve open-source readiness
- upgrade README with badges, CLI options table, "What You Get" section, links - add npm keywords for discoverability (ethereum, l2, web3, wagmi, viem, etc.) - add author field to package.json - add llms.txt for AI agent discoverability - add CODEOWNERS
1 parent a90f274 commit 8579210

4 files changed

Lines changed: 112 additions & 7 deletions

File tree

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @shape-network/core

README.md

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,51 @@
11
# create-shape-app
22

3-
CLI for scaffolding Shape apps from the Builder Kit template pinned to release tags.
3+
[![npm version](https://img.shields.io/npm/v/create-shape-app)](https://www.npmjs.com/package/create-shape-app)
4+
[![license](https://img.shields.io/npm/l/create-shape-app)](./LICENSE)
5+
6+
CLI for scaffolding [Shape](https://shape.network) apps from the [Builder Kit](https://github.com/shape-network/builder-kit) template.
47

58
## Quick Start
69

7-
Choose one:
8-
- `npx create-shape-app`
9-
- `bunx create-shape-app`
10+
```bash
11+
npx create-shape-app my-app
12+
```
13+
14+
Other package managers:
15+
16+
- `bunx create-shape-app my-app`
17+
- `pnpm dlx create-shape-app my-app`
18+
- `yarn create shape-app my-app`
19+
20+
## What You Get
21+
22+
A monorepo with everything needed to build on Shape:
23+
24+
- **`apps/web`** -- Next.js frontend with wagmi, viem, and wallet connection
25+
- **`packages/contract`** -- Hardhat project with a sample contract, deploy scripts, and tests
26+
- Pre-configured for Shape mainnet and Shape Sepolia
27+
- TypeScript throughout, Tailwind CSS styling
28+
29+
## CLI Options
30+
31+
| Flag | Description |
32+
|------|-------------|
33+
| `-y, --yes` | Skip confirmation prompts |
34+
| `--pm <bun\|npm\|pnpm\|yarn>` | Select package manager |
35+
| `--skip-install` | Skip dependency install step |
36+
| `--skip-git` | Skip git init + initial commit |
37+
| `--template-ref <tag>` | Pin to a specific Builder Kit release tag |
38+
| `-h, --help` | Show help |
39+
| `-v, --version` | Show version |
40+
41+
If `project-name` is omitted in an interactive terminal, you will be prompted.
42+
If `--pm` is omitted in an interactive terminal, you can pick a package manager.
1043

1144
## Behavior
45+
1246
- Scaffolds from `shape-network/builder-kit` release tags only (`latest` by default).
1347
- Rejects non-release refs (for example `main`) and canary tags.
1448
- In non-interactive terminals, `--yes` is required.
15-
- In interactive terminals, package manager is selectable when `--pm` is not provided.
1649
- Copies template files, excluding VCS/internal maintainer metadata.
1750
- Applies defaults:
1851
- Root `package.json` name is set from the project directory name.
@@ -21,6 +54,7 @@ Choose one:
2154
- Git is initialized unless `--skip-git` is set.
2255

2356
## Troubleshooting
57+
2458
- GitHub API rate limit during template lookup:
2559
- retry later, set `GITHUB_TOKEN`, or pass `--template-ref <tag>`.
2660
- Git init or commit failure:
@@ -38,12 +72,21 @@ bun run test
3872
```
3973

4074
## Publish
75+
4176
- Trigger: GitHub release publish event.
4277
- Guard: workflow checks release tag matches `package.json` version.
4378
- Requirement: repository secret `NPM_TOKEN` must be configured.
4479
- Publish target: npm package `create-shape-app`.
4580

81+
## Links
82+
83+
- [Shape](https://shape.network)
84+
- [Shape docs](https://docs.shape.network)
85+
- [Shape Discord](http://discord.com/invite/shape-l2)
86+
- [Builder Kit](https://github.com/shape-network/builder-kit)
87+
4688
## Community
89+
4790
- Contribution guide: `CONTRIBUTING.md`
4891
- Security policy: `SECURITY.md`
4992
- Code of conduct: `CODE_OF_CONDUCT.md`

llms.txt

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# create-shape-app
2+
3+
> CLI for scaffolding Shape apps from the Builder Kit template.
4+
5+
Shape is an EVM-compatible L2 built on the OP Stack.
6+
create-shape-app downloads the latest release of builder-kit and sets up a ready-to-run monorepo.
7+
8+
## Quick Start
9+
10+
- npx create-shape-app my-app
11+
- bunx create-shape-app my-app
12+
- pnpm dlx create-shape-app my-app
13+
- yarn create shape-app my-app
14+
15+
## CLI Options
16+
17+
- -y, --yes: Skip confirmation prompts
18+
- --pm <bun|npm|pnpm|yarn>: Select package manager
19+
- --skip-install: Skip dependency install step
20+
- --skip-git: Skip git init and initial commit
21+
- --template-ref <tag>: Pin to a specific Builder Kit release tag
22+
- -h, --help: Show help
23+
- -v, --version: Show version
24+
25+
## What It Scaffolds
26+
27+
A monorepo with two workspaces:
28+
29+
- apps/web: Next.js frontend with wagmi, viem, RainbowKit, and Tailwind CSS
30+
- packages/contract: Hardhat project with a sample Solidity contract, deploy scripts, and tests
31+
32+
Pre-configured for Shape mainnet (chain ID 360) and Shape Sepolia (chain ID 11011).
33+
34+
## Behavior
35+
36+
- Downloads from shape-network/builder-kit GitHub release tags only.
37+
- Rejects non-release refs and canary tags.
38+
- Copies .env.example to .env when present.
39+
- Installs dependencies unless --skip-install is set.
40+
- Initializes git unless --skip-git is set.
41+
- Requires --yes in non-interactive terminals (CI).
42+
43+
## Links
44+
45+
- Source: https://github.com/shape-network/create-shape-app
46+
- npm: https://www.npmjs.com/package/create-shape-app
47+
- Builder Kit: https://github.com/shape-network/builder-kit
48+
- Shape: https://shape.network
49+
- Shape docs: https://docs.shape.network
50+
- Shape Discord: http://discord.com/invite/shape-l2

package.json

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-shape-app",
3-
"version": "0.1.6",
3+
"version": "0.1.7",
44
"description": "Scaffold Shape Builder Kit projects from pinned release tags.",
55
"license": "MIT",
66
"repository": {
@@ -11,12 +11,22 @@
1111
"url": "https://github.com/shape-network/create-shape-app/issues"
1212
},
1313
"homepage": "https://github.com/shape-network/create-shape-app#readme",
14+
"author": "williamhzo",
1415
"keywords": [
1516
"cli",
1617
"create",
1718
"scaffold",
1819
"shape",
19-
"builder-kit"
20+
"builder-kit",
21+
"ethereum",
22+
"l2",
23+
"web3",
24+
"onchain",
25+
"nextjs",
26+
"hardhat",
27+
"wagmi",
28+
"viem",
29+
"dapp"
2030
],
2131
"publishConfig": {
2232
"access": "public"
@@ -26,6 +36,7 @@
2636
"files": [
2737
"bin",
2838
"dist",
39+
"llms.txt",
2940
"README.md",
3041
"LICENSE"
3142
],

0 commit comments

Comments
 (0)