From 9fba460707f6a5633a6ef8b64431f423e506d7a2 Mon Sep 17 00:00:00 2001 From: Bartlomiej Obecny Date: Sun, 25 Apr 2021 09:49:16 +0200 Subject: [PATCH] chore: updating readme headline and fixing links (#44) --- README.md | 39 ++++++++++++++++++++++++++++++++++----- 1 file changed, 34 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 96bbc542..4ab6a9ee 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,39 @@ + +--- +

+ + API Documentation +   •   + Getting In Touch (GitHub Discussions) + +

+ +

+ + GitHub release (latest by date including pre-releases) + + + Codecov Status + + + license + +
+ + Build Status + + + Build Status + +

+ +--- + # OpenTelemetry API for JavaScript [![NPM Published Version][npm-img]][npm-url] [![dependencies][dependencies-image]][dependencies-url] [![devDependencies][devDependencies-image]][devDependencies-url] -[![Apache License][license-image]][license-image] 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. @@ -50,7 +80,7 @@ const tracer = trace.getTracer(name, version); // Trace your application by creating spans async function operation() { const span = tracer.startSpan("do operation"); - + // mock some work by sleeping 1 second await new Promise((resolve, reject) => { setTimeout(resolve, 1000); @@ -88,12 +118,11 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions [license-url]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat -[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-api/status.svg +[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg [dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api -[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-api/dev-status.svg +[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg?type=dev [devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api?type=dev [npm-url]: https://www.npmjs.com/package/@opentelemetry/api [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi.svg - [docs-tracing]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/tracing.md [docs-sdk-registration]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/sdk-registration.md