Skip to content
This repository was archived by the owner on Nov 10, 2022. It is now read-only.

Commit 47692dc

Browse files
committed
chore: adding upgrade guidelines fixing links
1 parent f63a737 commit 47692dc

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ const tracer = trace.getTracer(name, version);
5050
// Trace your application by creating spans
5151
async function operation() {
5252
const span = tracer.startSpan("do operation");
53-
53+
5454
// mock some work by sleeping 1 second
5555
await new Promise((resolve, reject) => {
5656
setTimeout(resolve, 1000);
@@ -73,6 +73,12 @@ main();
7373

7474
Because the npm installer and node module resolution algorithm could potentially allow two or more copies of any given package to exist within the same `node_modules` structure, the OpenTelemetry API takes advantage of a variable on the `global` object to store the global API. When an API method in the API package is called, it checks if this `global` API exists and proxies calls to it if and only if it is a compatible API version. This means if a package has a dependency on an OpenTelemetry API version which is not compatible with the API used by the end user, the package will receive a no-op implementation of the API.
7575

76+
## Upgrade guidelines
77+
78+
### 1.0.0-rc.0 to x
79+
80+
- `HttpBaggage` renamed to `HttpBaggagePropagator`
81+
7682
## Useful links
7783

7884
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
@@ -88,9 +94,9 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
8894
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
8995
[license-url]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE
9096
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
91-
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-api/status.svg
97+
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg
9298
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api
93-
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-api/dev-status.svg
99+
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg?type=dev
94100
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api?type=dev
95101
[npm-url]: https://www.npmjs.com/package/@opentelemetry/api
96102
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi.svg

0 commit comments

Comments
 (0)