Skip to content

Commit

Permalink
feat: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
linbudu599 committed Mar 15, 2022
1 parent 1f29b81 commit aab6f77
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,17 +84,15 @@ or use command `pnpm cli copy` to add removed packages back:

Command: `pnpm cli reset`

This command recovers all the original packages,
and does not overwrite the already existing projects.
This command recovers all the original packages, and does not overwrite the already existing projects.

Useful when you want to start from scratch.

### Copy

Command: `pnpm cli copy`

This command can be useful when you want to have multiple projects based on the same initial template(starter),
for example you may want to develop several ESBuild plugins inside one workspace.
This command can be useful when you want to have multiple projects based on the same initial template(starter), for example you may want to develop several ESBuild plugins inside one workspace.

After you have selected the items you want to copy, you also need to rename them, which will be used to update `name` field in `package.json`.

Expand All @@ -104,6 +102,22 @@ After you have selected the items you want to copy, you also need to rename them
? Rename package esbuild-react-app › esbuild-react-todo
```

### Rename

Command: `pnpm cli rename`

Select starters and rename them(dir and `package.json` name field).

Useful when you want to rename some packages to be actually used.

### Cache

Command: `pnpm cli cache`

Cache all initial workspacr packages to cache dir. This will be executed in `postinstall` hook.

You can also execute command manually to cache some extra changes.

### Create

Command: `pnpm cli create`
Expand Down

0 comments on commit aab6f77

Please sign in to comment.