Skip to content

Commit 29bbc4f

Browse files
committed
docs(README): update guideline more precise
1 parent 67e0df6 commit 29bbc4f

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,22 @@ npm run prettier:format | yarn prettier:format
4444

4545
## How to use
4646

47-
### Clone the repository
47+
### Clone repository and name it
4848

4949
```bash
5050
git clone [email protected]:make-everything-simple/npm-template-typescript.git
51-
cd npm-template-typescript
51+
# rename to desire name folder
52+
mv npm-template-typescript $desire_name
53+
cd $desire_name
54+
# reinitialize existing Git repository
55+
git init
56+
# install dependencies
5257
npm install | yarn install
58+
# run build
59+
npm run build | yarn build
5360
```
5461

55-
### Open package.json file to edit some fields e.g. name, repository, etc
62+
### Update some fields e.g. name, repository, etc in package.json file
5663

5764
we can manage our package.json via [npm-pkg](https://docs.npmjs.com/cli/v10/commands/npm-pkg)
5865

0 commit comments

Comments
 (0)