chore: update README and package.json

README.md

@@ -1 +1,49 @@
-# TODO
+# OpenTelemetry JavaScript Contrib
+This is a repository for OpenTelemetry JavaScript contributions that are not part of the
+[core repository](https://github.com/open-telemetry/opentelemetry-js) and
+core distribution of the API and SDK.
+
+## Plugins
+
+OpenTelemetry can collect tracing data automatically using plugins. Vendors/Users can also create and use their own. Currently, OpenTelemetry supports automatic tracing for:
+
+#### Node Plugins
+- [@opentelemetry/plugin-grpc][otel-plugin-grpc]
+- [@opentelemetry/plugin-http][otel-plugin-http]
+- [@opentelemetry/plugin-https][otel-plugin-https]
+- [@opentelemetry/plugin-mongodb][otel-plugin-mongodb]
+- [@opentelemetry/plugin-mysql][otel-plugin-mysql]
+- [@opentelemetry/plugin-pg][otel-plugin-pg]
+- [@opentelemetry/plugin-pg-pool][otel-plugin-pg-pool]
+- [@opentelemetry/plugin-redis][otel-plugin-redis]
+- [@opentelemetry/plugin-ioredis][otel-plugin-ioredis]
+- [@opentelemetry/plugin-dns][otel-plugin-dns] - By default, this plugin is not loaded [#612](https://github.com/open-telemetry/opentelemetry-js/issues/612)
+- [@opentelemetry/plugin-express][otel-plugin-express] - By default, this plugin is not loaded
+
+#### Web Plugins
+- [@opentelemetry/plugin-document-load][otel-plugin-document-load]
+- [@opentelemetry/plugin-xml-http-request][otel-plugin-xml-http-request]
+- [@opentelemetry/plugin-user-interaction][otel-plugin-user-interaction]
+
+
+## Useful links
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For help or feedback on this project, join us on [gitter][node-gitter-url]
+
+## License
+
+Apache 2.0 - See [LICENSE][license-url] for more information.
+
+[node-gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/master/LICENSE
+[otel-plugin-dns]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-dns
+[otel-plugin-document-load]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web/opentelemetry-plugin-document-load
+[otel-plugin-ioredis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-ioredis
+[otel-plugin-mongodb]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-mongodb
+[otel-plugin-mysql]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-mysql
+[otel-plugin-pg-pool]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-pg-pool
+[otel-plugin-pg]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-pg
+[otel-plugin-redis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-redis
+[otel-plugin-user-interaction]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web/opentelemetry-plugin-user-interaction
+[otel-plugin-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web/opentelemetry-plugin-xml-http-request
+[otel-plugin-express]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-express

package.json

@@ -1,7 +1,7 @@
 {
   "name": "opentelemetry-contrib",
   "version": "0.6.1",
-  "description": "OpenTelemetry is a distributed tracing and stats collection framework.",
+  "description": "This is a repository for OpenTelemetry JavaScript contributions.",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "scripts": {
@@ -28,19 +28,17 @@
     "nodejs",
     "profiling",
     "metrics",
-    "stats"
+    "stats",
+    "plugins"
   ],
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "devDependencies": {
     "@commitlint/cli": "^8.3.4",
     "@commitlint/config-conventional": "^8.3.4",
-    "beautify-benchmark": "^0.2.4",
-    "benchmark": "^2.1.4",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-plugin-import": "^2.19.1",
-    "gh-pages": "^2.1.1",
     "gts": "^1.1.0",
     "husky": "^3.0.9",
     "lerna": "^3.17.0",