From d300476327f3969b6f5eb8071b87ffc5a3a35bd5 Mon Sep 17 00:00:00 2001 From: Rauno Viskus Date: Wed, 28 Jul 2021 19:43:50 +0300 Subject: [PATCH] docs(test-utils): add README.md for @opentelemetry/test-utils --- packages/opentelemetry-test-utils/README.md | 16 ++++++++++++++++ packages/opentelemetry-test-utils/package.json | 4 ++-- 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 packages/opentelemetry-test-utils/README.md diff --git a/packages/opentelemetry-test-utils/README.md b/packages/opentelemetry-test-utils/README.md new file mode 100644 index 0000000000..90970142e6 --- /dev/null +++ b/packages/opentelemetry-test-utils/README.md @@ -0,0 +1,16 @@ +# Test Utils for OpenTelemetry contrib packages + +This is a internal utils package used across the contrib packages. No guarantees are given to uses outside of [open-telemetry/opentelemetry-js-contrib](https://github.com/open-telemetry/opentelemetry-js-contrib/) repository. + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions diff --git a/packages/opentelemetry-test-utils/package.json b/packages/opentelemetry-test-utils/package.json index ebfea36c48..c7664979f7 100644 --- a/packages/opentelemetry-test-utils/package.json +++ b/packages/opentelemetry-test-utils/package.json @@ -20,9 +20,9 @@ "author": "OpenTelemetry Authors", "license": "Apache-2.0", "bugs": { - "url": "https://github.com/open-telemetry/opentelemetry-js/issues" + "url": "https://github.com/open-telemetry/opentelemetry-js-contrib/issues" }, - "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme", + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib#readme", "peerDependencies": { "@opentelemetry/api": "^1.0.1" },