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

Commit 9fba460

Browse files
authored
chore: updating readme headline and fixing links (#44)
1 parent 41109c8 commit 9fba460

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

README.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,39 @@
1+
2+
---
3+
<p align="center">
4+
<strong>
5+
<a href="https://open-telemetry.github.io/opentelemetry-js">API Documentation<a/>
6+
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
7+
<a href="https://github.com/open-telemetry/opentelemetry-js/discussions">Getting In Touch (GitHub Discussions)<a/>
8+
</strong>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://github.com/open-telemetry/opentelemetry-js-api/releases">
13+
<img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/open-telemetry/opentelemetry-js-api?include_prereleases&style=for-the-badge">
14+
</a>
15+
<a href="https://codecov.io/gh/open-telemetry/opentelemetry-js-api/branch/main/">
16+
<img alt="Codecov Status" src="https://img.shields.io/codecov/c/github/open-telemetry/opentelemetry-js-api?style=for-the-badge">
17+
</a>
18+
<a href="https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE">
19+
<img alt="license" src="https://img.shields.io/badge/license-Apache_2.0-green.svg?style=for-the-badge">
20+
</a>
21+
<br/>
22+
<a href="https://github.com/open-telemetry/opentelemetry-js-api/actions/workflows/docs.yaml">
23+
<img alt="Build Status" src="https://github.com/open-telemetry/opentelemetry-js-api/actions/workflows/test.yaml/badge.svg?branch=main">
24+
</a>
25+
<a href="https://github.com/open-telemetry/opentelemetry-js-api/actions/workflows/test.yaml?query=branch%3Amain">
26+
<img alt="Build Status" src="https://github.com/open-telemetry/opentelemetry-js-api/actions/workflows/docs.yaml/badge.svg">
27+
</a>
28+
</p>
29+
30+
---
31+
132
# OpenTelemetry API for JavaScript
233

334
[![NPM Published Version][npm-img]][npm-url]
435
[![dependencies][dependencies-image]][dependencies-url]
536
[![devDependencies][devDependencies-image]][devDependencies-url]
6-
[![Apache License][license-image]][license-image]
737

838
This package provides everything needed to interact with the OpenTelemetry API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser.
939

@@ -50,7 +80,7 @@ const tracer = trace.getTracer(name, version);
5080
// Trace your application by creating spans
5181
async function operation() {
5282
const span = tracer.startSpan("do operation");
53-
83+
5484
// mock some work by sleeping 1 second
5585
await new Promise((resolve, reject) => {
5686
setTimeout(resolve, 1000);
@@ -88,12 +118,11 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
88118
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
89119
[license-url]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE
90120
[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
121+
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg
92122
[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
123+
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg?type=dev
94124
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api?type=dev
95125
[npm-url]: https://www.npmjs.com/package/@opentelemetry/api
96126
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi.svg
97-
98127
[docs-tracing]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/tracing.md
99128
[docs-sdk-registration]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/sdk-registration.md

0 commit comments

Comments
 (0)