Skip to content

Commit 064b5af

Browse files
docs: update readme
1 parent bd847b2 commit 064b5af

1 file changed

Lines changed: 19 additions & 16 deletions

File tree

readme.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,37 @@
1-
# dAppBooster starter
1+
# dAppBooster installer
22

3-
Installs dAppBooster, using the last tag / release.
3+
An easy way to install and customize [dAppBooster](https://dappbooster.dev/)
44

55
## Usage
66

77
```shell
8-
$ pnpm dlx dappbooster <projectName>
8+
$ pnpm dlx dappbooster
99
```
1010

11+
dAppBooster documentation: https://docs.dappbooster.dev/
12+
1113
## Development
1214

13-
Move into the script's folder and then
15+
Clone the repo
1416

1517
```shell
16-
# Clone the repo
17-
git clone git@github.com:BootNodeDev/dAppBooster-starter.git
18+
git clone git@github.com:BootNodeDev/dAppBoosterInstallScript.git
19+
```
1820

19-
# Install dependencies
20-
pnpm i
21+
Move into the folder you just created and install the dependencies
22+
23+
```shell
24+
cd dAppBoosterInstallScript
2125

22-
# Move into the script's folder
23-
cd dAppBooster-starter
26+
pnpm i
2427
```
2528

26-
The common loop for testing the script looks something like
29+
You can run the script by doing
2730

2831
```shell
29-
# Test the script, creates a folder called test
30-
$ node index.js test
32+
$ node cli.js
33+
```
34+
35+
## Releasing new versions to NPM
3136

32-
# Remove the test directory (ignored in .gitignore)
33-
$ rm -rf test
34-
```
37+
New releases are automatically uploaded to NPM using GitHub actions.

0 commit comments

Comments
 (0)