From ce00041327a6bff5e89c192a54e942aa8ac3fd7f Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Tue, 26 Mar 2024 13:34:08 -0700 Subject: [PATCH] docs: minor tweaks to the READMEs for some clarity --- README.md | 9 ++------- packages/opentelemetry-node/README.md | 7 +++++-- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index da3ed790..b6c17284 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,8 @@ -# Disclaimer - -This is a work-in-progress. - # Elastic OpenTelemetry Node.js This repository holds Node.js packages authored by Elastic for using -OpenTelemetry. Primarily that includes +and working with OpenTelemetry. Primarily that includes [`@elastic/opentelemetry-node`](./packages/opentelemetry-node), the -Elastic distribution of the OpenTelemetry Node.js SDK. It may also +Elastic OpenTelemetry Node.js Distribution. It may also include other Elastic-authored instrumentations or other utilities. - diff --git a/packages/opentelemetry-node/README.md b/packages/opentelemetry-node/README.md index 0d7df937..f30294ab 100644 --- a/packages/opentelemetry-node/README.md +++ b/packages/opentelemetry-node/README.md @@ -1,11 +1,14 @@ -**Disclaimer**: This project is currently in early development. +# Elastic OpenTelemetry Node.js Distribution -This is Elastic's OpenTelemetry Node.js SDK distribution. It is a light wrapper +This is the Elastic OpenTelemetry Node.js Distribution. It is a light wrapper around the OpenTelemetry Node SDK that makes it easier to get started using OpenTelemetry in your Node.js applications, especially if you are using [Elastic Observability](https://www.elastic.co/observability) as your observability solution. +# Current status + +Pre-alpha # Install