Skip to content

Commit eeac55d

Browse files
committed
docs(readme): add note for windows users about cross env and npmrc setup
1 parent 70b7817 commit eeac55d

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ You need to have React [16.8.0](https://reactjs.org/blog/2019/02/06/react-v16.8.
3131
npm install @ubilabs/google-maps-react-hooks -D
3232
```
3333

34+
**NOTE FOR WINDOWS USERS**:
35+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
36+
3437
## Library
3538

3639
The full Google Maps React Hooks library can be found in the [library directory](./library).

library/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ You need to have React [16.8.0](https://reactjs.org/blog/2019/02/06/react-v16.8.
4949
npm install @ubilabs/google-maps-react-hooks -D
5050
```
5151

52+
**NOTE FOR WINDOWS USERS**:
53+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
54+
5255
## Map Usage
5356

5457
Import the `GoogleMapsProvider` and wrap it around your components.

0 commit comments

Comments
 (0)