Skip to content
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.

Sign up for GitHub

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

chore: update README per template #108

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore: update README per template #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 61 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# Automatically generated types for the Google Maps Platform JavaScript API
[![npm](https://img.shields.io/npm/v/@types/google.maps)][npm-pkg]
![Release](https://github.com/googlemaps/js-types/workflows/Release/badge.svg)
![Stable](https://img.shields.io/badge/stability-stable-green)
[![Tests/Build Status](https://github.com/googlemaps/js-types/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/js-types/actions/workflows/test.yml)

[![codecov](https://codecov.io/gh/googlemaps/js-types/branch/main/graph/badge.svg)](https://codecov.io/gh/googlemaps/js-types)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

![Build](https://github.com/googlemaps/js-types/workflows/Test/badge.svg)
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/js-types?color=green)
[![GitHub License](https://img.shields.io/github/license/googlemaps/js-types?color=blue)][license]
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]

# Automatically generated types for the Google Maps Platform JavaScript API

## Description

Expand All @@ -10,13 +19,62 @@ 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

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
* (others)

## 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]: CODE_OF_CONDUCT.md
[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

Loading