From 24ef63af4ba0935216b4d3f7fb89ba8d27c4da81 Mon Sep 17 00:00:00 2001 From: wesley chun Date: Thu, 12 Dec 2024 00:41:25 -0800 Subject: [PATCH 1/2] fix: update README per template --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 56 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d7e91f1..628cbe9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,56 @@ -# url-signing -Samples in various languages that demonstrate how to sign URLs for the Maps API Web Services +![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/url-signing?color=green) +[![GitHub License](https://img.shields.io/github/license/googlemaps/url-signing?color=blue)][license] +[![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. + +## 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]: 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/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 From 6b94733d0a4dc9b0302aef6840f061b929ddad17 Mon Sep 17 00:00:00 2001 From: wesley chun Date: Mon, 30 Dec 2024 22:10:43 -0800 Subject: [PATCH 2/2] chore: more README fixes from template --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 628cbe9..0d4b855 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/url-signing?color=green) -[![GitHub License](https://img.shields.io/github/license/googlemaps/url-signing?color=blue)][license] +![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 @@ -10,10 +11,10 @@ Samples in various languages that demonstrate how to [sign URLs](https://develop ## 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) +- [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 @@ -39,7 +40,7 @@ You can also discuss this library on our [Discord server]. [maps-sdk]: https://developers.google.com/maps/documentation/javascript [documentation]: https://googlemaps.github.io/url-signing -[code of conduct]: CODE_OF_CONDUCT.md +[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