Skip to content

Commit f2aac8e

Browse files
committed
Another update of installation instructions and deps structure
1 parent 9085d4a commit f2aac8e

File tree

3 files changed

+1160
-20
lines changed

3 files changed

+1160
-20
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ Install this package as
99
$ npm install --save topcoder-react-utils
1010
```
1111

12+
You are done if you will use only components and utilities provided by this
13+
package. If you are to use configurations, to build or test your code, you must
14+
also install the peer dependencies:
15+
```
16+
$ npm install -g install-peerdeps
17+
$ install-peerdeps -od topcoder-react-utils
18+
```
19+
20+
Peer dependencies will be also stored as dev dependencies into `package.json` of
21+
your project, thus future invokations of `npm install` will automatically
22+
install them, and you won't need to use `install-peerdeps` as long as you don't
23+
update `topcoder-react-utils` version.
24+
1225
### Configurations
1326
- [**Babel Configurations**](docs/babel-config.md) — Standard configurations
1427
for [Babel](https://babeljs.io/);

0 commit comments

Comments
 (0)