From 02bf23f9d6e36881e6c529a66c8d3793da0fa784 Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Tue, 29 Mar 2022 08:07:42 -0700 Subject: [PATCH] Update README.md Add go package documentation link. Add all import paths to example usage. --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3ef5694..eb6b177 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,28 @@ # opentelemetry-proto-go -Generated code for OpenTelemetry protobuf data model +[![Go Reference](https://pkg.go.dev/badge/go.opentelemetry.io/proto/otlp.svg)](https://pkg.go.dev/go.opentelemetry.io/proto/otlp) -## Usage +Generated Go code for the OpenTelemetry protobuf data model. -You can import the generated code directly in your project +## Getting Started + +Install the latest version in your project. + +```sh +go get go.opentelemetry.io/proto/otlp@latest +``` + +Import the generated code directly in your project. ```go -import tracepb "go.opentelemetry.io/proto/otlp/trace/v1" +import ( + collogspb "go.opentelemetry.io/proto/otlp/collector/logs/v1" + colmetricspb "go.opentelemetry.io/proto/otlp/collector/metrics/v1" + coltracepb "go.opentelemetry.io/proto/otlp/collector/trace/v1" + commonpb "go.opentelemetry.io/proto/otlp/common/v1" + logspb "go.opentelemetry.io/proto/otlp/logs/v1" + metricspb "go.opentelemetry.io/proto/otlp/metrics/v1" + resourcepb "go.opentelemetry.io/proto/otlp/resource/v1" + tracepb "go.opentelemetry.io/proto/otlp/trace/v1" +) ```