From 11e4bdce69d52c9019eb7d37322b299d50ae9b8c Mon Sep 17 00:00:00 2001 From: wesley chun Date: Mon, 30 Dec 2024 22:10:36 -0800 Subject: [PATCH] chore: more README fixes from template --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b4cce8d4..b21b7d18 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ [![npm](https://img.shields.io/npm/v/@googlemaps/typescript-guards)][npm-pkg] -![Tests/Build Status](https://github.com/googlemaps/js-typescript-guards/actions/workflows/test.yml/badge.svg) ![Release](https://github.com/googlemaps/js-typescript-guards/workflows/Release/badge.svg) ![Stable](https://img.shields.io/badge/stability-stable-green) +[![Tests/Build](https://github.com/googlemaps/js-typescript-guards/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/js-typescript-guards/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/googlemaps/js-typescript-guards/branch/main/graph/badge.svg)](https://codecov.io/gh/googlemaps/js-typescript-guards) [![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) [![solidarity](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat.png)](https://github.com/apps/in-solidarity) -![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/js-typescript-guards?color=green) -[![GitHub License](https://img.shields.io/github/license/googlemaps/js-typescript-guards?color=blue)][license] +![Contributors](https://img.shields.io/github/contributors/googlemaps/js-typescript-guards?color=green) +[![License](https://img.shields.io/github/license/googlemaps/js-typescript-guards?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] # Google Maps TypeScript Guards @@ -21,10 +22,10 @@ A type guard (or type predicate) is an expression that performs a runtime check ## 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 -* Node.js and NPM +- [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 +- Node.js and NPM ## Installation @@ -81,7 +82,7 @@ You can also discuss this library on our [Discord server]. [documentation]: https://googlemaps.github.io/js-typescript-guards [npm-pkg]: https://npmjs.com/package/@googlemaps/typescript-guards -[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