Skip to content

Commit ebc20f8

Browse files
authored
Merge pull request #12 from distributed-system-analysis/linking
Update documentation for symlinking package folder during development
2 parents f57c3a6 + 4c78e72 commit ebc20f8

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,34 +52,35 @@ The `tests` directory represents the testing environment for ensuring native fun
5252
Install Testing Environment Dependencies
5353

5454
```bash
55-
$ npm install
55+
$ yarn install
5656
```
5757

5858
Install Local jschart Node Module
5959

6060
```bash
61-
$ npm install --save ../jschart/
61+
$ cd jschart
62+
$ yarn link
63+
$ cd ../tests
64+
$ yarn link "jschart"
6265
```
6366

64-
This will create a reference to the `jschart/` directory under dependencies in `package.json`:
67+
Verify Local jschart Node Module Installation
6568

66-
```
67-
"dependencies": {
68-
"jschart": "file:jschart"
69-
}
69+
```bash
70+
$ readlink -e node_modules/jschart
7071
```
7172

7273
Start Development Server
7374

7475
```bash
75-
$ npm start
76+
$ yarn start
7677
```
7778

7879
## Publishing Node Module
7980

8081
```bash
81-
$ npm login
82-
$ npm publish
82+
$ yarn login
83+
$ yarn publish
8384
```
8485

8586
## Detailed Usage

0 commit comments

Comments
 (0)