Skip to content

Commit

Permalink
chore: add peer dependencies note
Browse files Browse the repository at this point in the history
  • Loading branch information
VictorVelarde committed Mar 11, 2021
1 parent c9d43b2 commit 02fb2c0
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Expand Up @@ -38,7 +38,9 @@ There is a Storybook guide with the main UI components and how to use them at [C

### How to install the library

If you are using the CARTO CRA templates, everything is already setup, so no further configuration is needed!
If you are using the `CARTO CRA templates`, everything is already setup, so **no further configuration is needed!**

---

In case you want to use this set of packages in a different context, then you would need to install them as usual, with something like:

Expand All @@ -54,3 +56,24 @@ In case you want to use this set of packages in a different context, then you wo
```

Notice that to avoid issues within host projects, most of the base libraries are declared as **peer dependencies**. That means that you would need to add them explicitly to your project, if you are still not using them (keep an eye on the console warnings on peer dependencies).

Current peer deps are:

```
@deck.gl/core@^8.4.0 \
@deck.gl/extensions@^8.4.0 \
@deck.gl/google-maps@^8.4.0 \
@material-ui/core \
@material-ui/icons \
@material-ui/lab \
@reduxjs/toolkit \
@turf/bbox-polygon \
@turf/boolean-intersects \
echarts@^4.9.0 \
echarts-for-react@^2.0.16 \
prop-types \
react@^17.0.1 \
react-dom@^17.0.1 \
react-is@^17.0.1 \
react-redux@^7.2.2
```

0 comments on commit 02fb2c0

Please sign in to comment.