Skip to content
Open
Changes from all commits
Commits
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
59 changes: 57 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,57 @@
# url-signing
Samples in various languages that demonstrate how to sign URLs for the Maps API Web Services
![Contributors](https://img.shields.io/github/contributors/googlemaps/url-signing?color=green)
[![License](https://img.shields.io/github/license/googlemaps/url-signing?color=blue)][license]
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]

# URL-signing sample apps

## Description

Samples in various languages that demonstrate how to [sign URLs](https://developers.google.com/maps/documentation/maps-static/digital-signature) for the Google Maps Platform Web APIs and Web Services APIs.

## Requirements

- [Sign up with Google Maps Platform]
- A Google Maps Platform [project] with the desired **Maps APIs** enabled
- An [API key] associated with the project above
- A [URL signing secret](https://developers.google.com/maps/documentation/maps-static/digital-signature#get-secret) from your project's [credentials console page](https://console.cloud.google.com/project/_/google/maps-apis/credentials)

## Contributing

External contributions are not (yet) accepted for this repository. See [contributing guide] for more info.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with note that we should add contributors guide, license, and code of conduct. I don't know whether we should proceed with this PR if they 404. Will discuss in chat.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. You & Angela need to make a call on what to do with this repo before we proceed. Since every other repo has these 3 core documents, the fact they're missing here suggests it may be deliberate. Otherwise it was pulled together extremely quickly without much thought of "compliance" and consistency with the other repos.


## 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/url-signing

[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/url-signing/issues/new/choose
[license]: LICENSE
[pull request]: https://github.com/googlemaps/url-signing/compare
[project]: https://developers.google.com/maps/documentation/javascript/cloud-setup#enabling-apis
[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/url-signing/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