Skip to content

Commit

Permalink
Update README.md (#60)
Browse files Browse the repository at this point in the history
Add go package documentation link.
Add all import paths to example usage.
  • Loading branch information
MrAlias committed Mar 29, 2022
1 parent 3fb3b35 commit d7702c6
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions 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"
)
```

0 comments on commit d7702c6

Please sign in to comment.