From aab6f778c01ffe6b04e85e9a48a8ea6b4e23a2f1 Mon Sep 17 00:00:00 2001 From: linbudu599 Date: Tue, 15 Mar 2022 11:56:51 +0800 Subject: [PATCH] feat: update README --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 92223d7..a2452c5 100644 --- a/README.md +++ b/README.md @@ -84,8 +84,7 @@ 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. @@ -93,8 +92,7 @@ Useful when you want to start from scratch. 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`. @@ -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`