Skip to content

Commit bcc5b1d

Browse files
committedJan 6, 2020
docs: add usage for yarn user
1 parent 6bb289a commit bcc5b1d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed
 

‎README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,20 @@ According to the instruction, we need to authenticate to the GitHub Packages wit
5454
registry=https://npm.pkg.github.com/pingcap-incubator
5555
```
5656

57+
If you use yarn, create .yarnrc instead of the .npmrc, fill with following content:
58+
59+
```
60+
"@pingcap-incubator:registry" "https://npm.pkg.github.com"
61+
```
62+
5763
1. Install the @pingcap-incubator/pd-client-js for your project
5864

5965
```sh
6066
$ npm install @pingcap-incubator/pd-client-js
6167
```
6268

69+
If you use yarn, add the `"@pingcap-incubator/pd-client-js": "^0.1.5"` into the package.json, then run `yarn install --update-checksums`. Related issue about yarn: [Integrity checked failed error](https://github.com/yarnpkg/yarn/issues/7552).
70+
6371
### Use
6472

6573
Create an instance of PDClient and call its methods:
@@ -76,4 +84,4 @@ client.getHeatmap()
7684

7785
## License
7886

79-
PD-Web is under the Apache 2.0 license.
87+
pd-client-js is under the Apache 2.0 license.

0 commit comments

Comments
 (0)
Please sign in to comment.