docs(test-utils): add README.md for @opentelemetry/test-utils

open-telemetry · Jul 28, 2021 · d300476 · d300476
1 parent fc70b9a
commit d300476
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/packages/opentelemetry-test-utils/README.md 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: <https://opentelemetry.io/>
+- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+- 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
@@ -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"
   },