| 1 | # react-google-maps
|
| 2 | > React.js Google Maps integration component
|
| 3 |
|
| 4 | [![Version][npm-image]][npm-url] [![Travis CI][travis-image]][travis-url] [![Quality][codeclimate-image]][codeclimate-url] [![Coverage][codeclimate-coverage-image]][codeclimate-coverage-url] [![Dependencies][gemnasium-image]][gemnasium-url] [![Gitter][gitter-image]][gitter-url]
|
| 5 |
|
| 6 |
|
| 7 | ## Usage / Documentation
|
| 8 |
|
| 9 | ```sh
|
| 10 | npm install --save react-google-maps
|
| 11 | ```
|
| 12 |
|
| 13 | Then, read the [documentation][documentation].
|
| 14 |
|
| 15 |
|
| 16 | ## Changelog
|
| 17 |
|
| 18 | The changelog is automatically generated via [standard-version][standard-version] and [can be found in project root](https://github.com/tomchentw/react-google-maps/blob/master/CHANGELOG.md) as well as npm tarball.
|
| 19 |
|
| 20 |
|
| 21 | ## Getting Help
|
| 22 |
|
| 23 | **For support or usage questions like “how do I do X with React-Google-Maps” and “my code doesn't work”, please search and ask on StackOverflow [with a google-maps tag](https://stackoverflow.com/questions/tagged/google-maps?sort=votes&pageSize=50) or [use react-google-maps as a keyword](https://stackoverflow.com/search?q=react-google-maps) first.**
|
| 24 |
|
| 25 | We ask you to do this because StackOverflow has a much better job at keeping popular questions visible. Unfortunately good answers get lost and outdated on GitHub.
|
| 26 |
|
| 27 | Some questions take a long time to get an answer. **If your question gets closed or you don't get a reply on StackOverflow for longer than a few days,** we encourage you to post an issue linking to your question. We will close your issue but this will give people watching the repo an opportunity to see your question and reply to it on StackOverflow if they know the answer.
|
| 28 |
|
| 29 | Please be considerate when doing this as this is not the primary purpose of the issue tracker.
|
| 30 |
|
| 31 |
|
| 32 | ## For contributors
|
| 33 |
|
| 34 | <details>
|
| 35 | <summary>Some simple guidelines</summary>
|
| 36 |
|
| 37 | * **Don't** manually modify `lib` folder. They're generated during `yarn release` process
|
| 38 | * Follow [conventional-commits-specification][conventional-commits-specification]
|
| 39 | * [standard-version][standard-version]
|
| 40 | * Auto generated: `src/marcos` -> `src/components` -> `lib/components`
|
| 41 | * Other components are manually maintained
|
| 42 | * Use `yarn` and keep `yarn.lock` updated in PR
|
| 43 | * Discuss! Discuss! Discuss!
|
| 44 |
|
| 45 | </details>
|
| 46 |
|
| 47 |
|
| 48 | [npm-image]: https://img.shields.io/npm/v/react-google-maps.svg?style=flat-square
|
| 49 | [npm-url]: https://www.npmjs.org/package/react-google-maps
|
| 50 |
|
| 51 | [travis-image]: https://img.shields.io/travis/tomchentw/react-google-maps.svg?style=flat-square
|
| 52 | [travis-url]: https://travis-ci.org/tomchentw/react-google-maps
|
| 53 | [codeclimate-image]: https://img.shields.io/codeclimate/github/tomchentw/react-google-maps.svg?style=flat-square
|
| 54 | [codeclimate-url]: https://codeclimate.com/github/tomchentw/react-google-maps
|
| 55 | [codeclimate-coverage-image]: https://img.shields.io/codeclimate/coverage/github/tomchentw/react-google-maps.svg?style=flat-square
|
| 56 | [codeclimate-coverage-url]: https://codeclimate.com/github/tomchentw/react-google-maps
|
| 57 | [gemnasium-image]: https://img.shields.io/gemnasium/tomchentw/react-google-maps.svg?style=flat-square
|
| 58 | [gemnasium-url]: https://gemnasium.com/tomchentw/react-google-maps
|
| 59 | [gitter-image]: https://badges.gitter.im/Join%20Chat.svg
|
| 60 | [gitter-url]: https://gitter.im/tomchentw/react-google-maps?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
| 61 |
|
| 62 |
|
| 63 | [tomchentw]: https://github.com/tomchentw
|
| 64 | [documentation]: https://tomchentw.github.io/react-google-maps/
|
| 65 | [standard-version]: https://github.com/conventional-changelog/standard-version
|
| 66 | [conventional-commits-specification]: https://conventionalcommits.org/
|