-
Notifications
You must be signed in to change notification settings - Fork 7
chore: update README per template #108
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
wescpy
wants to merge
3
commits into
main
Choose a base branch
from
wescpy
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,17 @@ | ||
| # Automatically generated types for the Google Maps Platform JavaScript API | ||
| [][npm-pkg] | ||
|  | ||
|  | ||
| [](https://github.com/googlemaps/js-types/actions/workflows/test.yml) | ||
|
|
||
| [](https://codecov.io/gh/googlemaps/js-types) | ||
| [](https://github.com/semantic-release/semantic-release) | ||
|
|
||
|  | ||
|  | ||
|  | ||
| [][license] | ||
| [](https://stackoverflow.com/questions/tagged/google-maps) | ||
| [][Discord server] | ||
|
|
||
| # Automatically generated types for the Google Maps Platform JavaScript API | ||
|
|
||
| ## Description | ||
|
|
||
|
|
@@ -10,13 +20,61 @@ See [@types/google.maps](https://www.npmjs.com/package/@types/google.maps). | |
| This package includes an automatically generated index.d.ts for the Google Maps | ||
| Platform JavaScript API. | ||
|
|
||
| > **Note**: To report an issue with these types, please open a support ticket at https://issuetracker.google.com/savedsearches/558438. | ||
| > **Note**: To report an issue with these types, please open a support ticket at https://issuetracker.google.com/savedsearches/558438 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Noting here that the saved search no longer exists, but the problem existed before.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you have:
|
||
|
|
||
| Any changes made to the types in this repository will be overwritten with the next weekly release. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - [Sign up with Google Maps Platform] | ||
| - A Google Maps Platform [project] with the [**Maps Javascript API**][maps-sdk] enabled | ||
| - An [API key] associated with the project above | ||
|
|
||
| ## Install | ||
|
|
||
| `npm i -D @types/google.maps` | ||
|
|
||
| Any change in this repository is automatically synced to | ||
| [@types/google.maps](https://www.npmjs.com/package/@types/google.maps). | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are welcome and encouraged! If you'd like to contribute, send us a [pull request] and refer to our [code of conduct] and [contributing guide]. | ||
|
|
||
| ## Terms of Service | ||
|
|
||
| This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the Google Maps Platform [Terms of Service]. | ||
|
|
||
| This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service (e.g. Technical Support Services, Service Level Agreements, and Deprecation Policy) do not apply to the code in this library. | ||
|
|
||
| ## Support | ||
|
|
||
| This library is offered via an open source [license]. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines, the SLA, or the [Deprecation Policy]. However, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service. | ||
|
|
||
| This library adheres to [semantic versioning] to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time. | ||
|
|
||
| If you find a bug, or have a feature request, please [file an issue] on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels]. If you'd like to contribute, please check the [contributing guide]. | ||
|
|
||
| You can also discuss this library on our [Discord server]. | ||
|
|
||
| [API key]: https://developers.google.com/maps/documentation/javascript/get-api-key | ||
| [maps-sdk]: https://developers.google.com/maps/documentation/javascript | ||
| [documentation]: https://googlemaps.github.io/js-types | ||
| [npm-pkg]: https://npmjs.com/package/@types/google.maps | ||
|
|
||
| [code of conduct]: ?tab=coc-ov-file#readme | ||
| [contributing guide]: CONTRIBUTING.md | ||
| [Deprecation Policy]: https://cloud.google.com/maps-platform/terms | ||
| [developer community channels]: https://developers.google.com/maps/developer-community | ||
| [Discord server]: https://discord.gg/hYsWbmk | ||
| [file an issue]: https://github.com/googlemaps/js-types/issues/new/choose | ||
| [license]: LICENSE | ||
| [project]: https://developers.google.com/maps/documentation/javascript/cloud-setup#enabling-apis | ||
| [pull request]: https://github.com/googlemaps/js-types/compare | ||
| [semantic versioning]: https://semver.org | ||
| [Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start | ||
| [similar inquiry]: https://github.com/googlemaps/js-types/issues | ||
| [SLA]: https://cloud.google.com/maps-platform/terms/sla | ||
| [Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg | ||
| [Terms of Service]: https://cloud.google.com/maps-platform/terms | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.