diff --git a/README.md b/README.md index 07760e2..c3736c5 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,30 @@ -routing-info -============= +# routing-info + +[![Go Report +Card](https://goreportcard.com/badge/code.cloudfoundry.org/routing-info)](https://goreportcard.com/report/code.cloudfoundry.org/routing-info) +[![Go +Reference](https://pkg.go.dev/badge/code.cloudfoundry.org/routing-info.svg)](https://pkg.go.dev/code.cloudfoundry.org/routing-info) Routing information for HTTP and TCP Routes -**Note**: This repository should be imported as `code.cloudfoundry.org/routing-info`. +> \[!NOTE\] +> +> This repository should be imported as +> `code.cloudfoundry.org/routing-info`. + +# Contributing -### Dependencies +See the [Contributing.md](./.github/CONTRIBUTING.md) for more +information on how to contribute. -This repository's dependencies are managed using -[routing-release](https://github.com/cloudfoundry/routing-release). Please refer to documentation in that repository for setting up tests +# Working Group Charter -### Executables +This repository is maintained by [App Runtime +Platform](https://github.com/cloudfoundry/community/blob/main/toc/working-groups/app-runtime-platform.md) +under `Networking` area. -1. `bin/test.bash`: This file is used to run test in Docker & CI. Please refer to [Dependencies](#dependencies) for setting up tests. +> \[!IMPORTANT\] +> +> Content in this file is managed by the [CI task +> `sync-readme`](https://github.com/cloudfoundry/wg-app-platform-runtime-ci/blob/c83c224ad06515ed52f51bdadf6075f56300ec93/shared/tasks/sync-readme/metadata.yml) +> and is generated by CI following a convention.