Skip to content

Commit 7e13991

Browse files
committed
docs: add package metadata and improve README with agent quickstart
1 parent 97b5e88 commit 7e13991

File tree

2 files changed

+34
-9
lines changed

2 files changed

+34
-9
lines changed

package.json

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
{
22
"name": "dappbooster",
33
"version": "3.1.4",
4+
"description": "Agent-friendly dAppBooster installer that scaffolds Web3 dApps via TUI or non-interactive CLI/CI.",
5+
"keywords": [
6+
"dappbooster",
7+
"dapp",
8+
"web3",
9+
"blockchain",
10+
"ethereum",
11+
"evm",
12+
"scaffolding",
13+
"starter",
14+
"template",
15+
"cli",
16+
"installer",
17+
"generator",
18+
"tui",
19+
"non-interactive",
20+
"ci",
21+
"agent",
22+
"automation"
23+
],
424
"license": "MIT",
525
"repository": {
626
"type": "git",
@@ -19,9 +39,7 @@
1939
"lint": "pnpm biome check",
2040
"lint:fix": "pnpm biome check --write"
2141
},
22-
"files": [
23-
"dist"
24-
],
42+
"files": ["dist"],
2543
"dependencies": {
2644
"figures": "^6.1.0",
2745
"ink": "^5.2.1",
@@ -45,8 +63,6 @@
4563
"vitest": "^4.1.0"
4664
},
4765
"pnpm": {
48-
"onlyBuiltDependencies": [
49-
"@biomejs/biome"
50-
]
66+
"onlyBuiltDependencies": ["@biomejs/biome"]
5167
}
5268
}

readme.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# dAppBooster installer
22

3-
An easy way to install and customize [dAppBooster](https://dappbooster.dev/)
3+
Agent-friendly installer for [dAppBooster](https://dappbooster.dev/) that scaffolds Web3 dApps via TUI or non-interactive CLI/CI with JSON output.
44

55
## Requirements
66

@@ -17,7 +17,16 @@ pnpm dlx dappbooster
1717

1818
dAppBooster documentation: https://docs.dappbooster.dev/
1919

20-
## Non-interactive / CI mode
20+
## Agent / CI quickstart
21+
22+
Use `--info` to discover features, then run a non-interactive install that returns JSON.
23+
24+
```shell
25+
pnpm dlx dappbooster --info
26+
pnpm dlx dappbooster --ni --name my_dapp --mode full
27+
```
28+
29+
## Agent / non-interactive / CI mode
2130

2231
The installer supports a non-interactive mode for CI pipelines and AI agents. It activates automatically when stdout is not a TTY, or explicitly with the `--ni` flag.
2332

@@ -141,4 +150,4 @@ node cli.js
141150

142151
## Releasing new versions to NPM
143152

144-
New releases are automatically uploaded to NPM using GitHub actions.
153+
New releases are automatically uploaded to NPM using GitHub actions.

0 commit comments

Comments
 (0)