Skip to content

Commit 114d11d

Browse files
committed
README update
1 parent c00555b commit 114d11d

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

README.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -122,29 +122,11 @@ Whenever you are to do any changes in the library, keep in mind the following:
122122
### Local Testing of Library Updates within a Host Project
123123

124124
To locally test how your library updates work within a host project relying on
125-
the lib (without releasing them to NPM), do the following:
126-
127-
1. In the library root execute `$ npm run build` to build the library, using
128-
the current code;
129-
130-
2. In the library root execute `$ npm pack .` it will pack the library into the
131-
tarball file `topcoder-react-utils-x.y.z.tgz`, where **x.y.z** is the
132-
library version specified in `package.json`.
133-
134-
3. In the host project execute
135-
`$ npm install --save PATH/TO/topcoder-react-utils-x.y.z.tgz` to install
136-
the local version of library build and packed at the previous steps. For
137-
all practical purposes, the installation will be performed the same way,
138-
as when the library is publised to NPM and installed from there.
139-
140-
4. In case your update of **topcoder-react-utils** alters dependency versions,
141-
and you need to ensure the same dependency versions installed in the host
142-
project, execute `$ ./node_modules/.bin/topcoder-lib-setup --just-fix-deps`
143-
in the host project's root.
144-
145-
5. Once you are done with the testing do not forget to ensure that the proper
146-
NPM version of **topcoder-react-utils** is saved back to the project's
147-
`package.json` file.
125+
the lib (without releasing them to NPM), use
126+
[`npm link`](https://docs.npmjs.com/cli/link.html) to link local copy of the lib
127+
into the host project, then run `npm run build:dev:watch` in the library root to
128+
automatically re-build the lib when you change it, and use the host project to
129+
see the final effect of changes you make.
148130

149131
### Library Releases to NPM
150132

0 commit comments

Comments
 (0)