ref: Changelog and Readme

HazAT · HazAT · commit 6e43443f3a93 · 2019-03-20T08:04:32.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## v5
+## 5.0.0-beta1
 
 ### Migration from v4
 
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
 - [`@sentry/node`](https://github.com/getsentry/sentry-javascript/tree/master/packages/node): SDK for Node, including
   integrations for Express, Koa, Loopback, Sails and Connect
 - [`@sentry/integrations`](https://github.com/getsentry/sentry-javascript/tree/master/packages/integrations): Pluggable
-  integrations that can be used to enchance JS SDKs
+  integrations that can be used to enhance JS SDKs
 - [`@sentry/electron`](https://github.com/getsentry/sentry-electron): SDK for Electron with support for native crashes
 - [`sentry-cordova`](https://github.com/getsentry/sentry-cordova): SDK for Cordova Apps and Ionic with support for
   native crashes
@@ -84,6 +84,8 @@ below:
   JavaScript SDKs with interfaces, type definitions and base classes.
 - [`@sentry/utils`](https://github.com/getsentry/sentry-javascript/tree/master/packages/utils): A set of helpers and
   utility functions useful for various SDKs.
+- [`@sentry/opentracing`](https://github.com/getsentry/sentry-javascript/tree/master/packages/opentracing): OpenTracing
+  compatible integration that can be used as a pluggable integration for the SDKs.
 - [`@sentry/typescript`](https://github.com/getsentry/sentry-javascript/tree/master/packages/typescript): Shared
   Typescript compiler and linter options.
 - [`@sentry/types`](https://github.com/getsentry/sentry-javascript/tree/master/packages/types): Types used in all
diff --git a/dangerfile.ts b/dangerfile.ts
@@ -5,7 +5,7 @@ import { resolve } from 'path';
 import tslint from 'danger-plugin-tslint';
 import { prettyResults } from 'danger-plugin-tslint/dist/prettyResults';
 
-const packages = ['browser', 'core', 'hub', 'integrations', 'minimal', 'node', 'types', 'utils'];
+const packages = ['browser', 'core', 'hub', 'integrations', 'opentracing', 'minimal', 'node', 'types', 'utils'];
 
 export default async () => {
   if (!danger.github) {
@@ -48,6 +48,6 @@ export default async () => {
 
   schedule(async () => {
     const result = (await promisify(exec)('cd packages/browser; yarn size:check')).stdout;
-    message(`@sentry/browser bundle gzip'ed minified size: \n${result.split('\n')[2]}\n${result.split('\n')[3]}`);
+    message(`@sentry/browser bundle gzip'ed minified size: \n${result.split('\n')[4]}\n${result.split('\n')[5]}`);
   });
 };
diff --git a/packages/opentracing/README.md b/packages/opentracing/README.md
@@ -19,4 +19,21 @@
 
 ## General
 
-TBD
+This package implements the OpenTracing API and provides an integration that can be used by our other SDKs.
+
+```js
+import * as Sentry from '@sentry/browser';
+import * as OpenTracing from '@sentry/opentracing';
+
+const ot = new OpenTracing.Integration(ENV.traceId);
+
+Sentry.init({
+  debug: true,
+  dsn: ENV.sentry.dsn,
+  integrations: [ot],
+  beforeSend(event) {
+    console.log(event);
+    return event;
+  },
+});
+```
