add a readme to all packages

open-telemetry · Mar 25, 2024 · 0d0f8b0 · 0d0f8b0
1 parent 354609c
commit 0d0f8b0
Show file tree

Hide file tree

Showing 22 changed files with 66 additions and 0 deletions.
diff --git a/bridge/opencensus/README.md b/bridge/opencensus/README.md
@@ -0,0 +1,3 @@
+# OpenTelemetry/OpenCensus Bridge
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/bridge/opencensus)](https://pkg.go.dev/go.opentelemetry.io/otel/bridge/opencensus)
diff --git a/bridge/opencensus/test/README.md b/bridge/opencensus/test/README.md
@@ -0,0 +1,3 @@
+# OpenTelemetry/OpenCensus Bridge Tests
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/bridge/opencensus/test)](https://pkg.go.dev/go.opentelemetry.io/otel/bridge/opencensus/test)
diff --git a/bridge/opentracing/test/README.md b/bridge/opentracing/test/README.md
@@ -0,0 +1,3 @@
+# OpenTelemetry/OpenTracing Bridge Tests
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/bridge/opentracing/test)](https://pkg.go.dev/go.opentelemetry.io/otel/bridge/opentracing/test)
diff --git a/example/dice/README.md b/example/dice/README.md
@@ -0,0 +1,3 @@
+# Dice Example
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/example/dice)](https://pkg.go.dev/go.opentelemetry.io/otel/example/dice)
diff --git a/example/namedtracer/README.md b/example/namedtracer/README.md
@@ -0,0 +1,3 @@
+# Named Tracer Example
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/example/namedtracer)](https://pkg.go.dev/go.opentelemetry.io/otel/example/namedtracer)
diff --git a/example/opencensus/README.md b/example/opencensus/README.md
@@ -0,0 +1,3 @@
+# Opencensus Example
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/example/opencensus)](https://pkg.go.dev/go.opentelemetry.io/otel/example/opencensus)
diff --git a/example/prometheus/README.md b/example/prometheus/README.md
@@ -0,0 +1,3 @@
+# Prometheus Example
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/example/prometheus)](https://pkg.go.dev/go.opentelemetry.io/otel/example/prometheus)
diff --git a/exporters/otlp/otlpmetric/otlpmetricgrpc/README.md b/exporters/otlp/otlpmetric/otlpmetricgrpc/README.md
@@ -0,0 +1,3 @@
+# OTLP Metric gRPC Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc)
diff --git a/exporters/otlp/otlpmetric/otlpmetrichttp/README.md b/exporters/otlp/otlpmetric/otlpmetrichttp/README.md
@@ -0,0 +1,3 @@
+# OTLP Metric HTTP Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp)
diff --git a/exporters/otlp/otlptrace/README.md b/exporters/otlp/otlptrace/README.md
@@ -0,0 +1,3 @@
+# OTLP Trace Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlptrace)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace)
diff --git a/exporters/otlp/otlptrace/otlptracegrpc/README.md b/exporters/otlp/otlptrace/otlptracegrpc/README.md
@@ -0,0 +1,3 @@
+# OTLP Trace gRPC Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc)
diff --git a/exporters/otlp/otlptrace/otlptracehttp/README.md b/exporters/otlp/otlptrace/otlptracehttp/README.md
@@ -0,0 +1,3 @@
+# OTLP Trace HTTP Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)
diff --git a/exporters/prometheus/README.md b/exporters/prometheus/README.md
@@ -0,0 +1,3 @@
+# Prometheus Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/prometheus)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/prometheus)
diff --git a/exporters/stdout/stdoutmetric/README.md b/exporters/stdout/stdoutmetric/README.md
@@ -0,0 +1,3 @@
+# STDOUT Metric Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/stdout/stdoutmetric)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/stdout/stdoutmetric)
diff --git a/exporters/stdout/stdouttrace/README.md b/exporters/stdout/stdouttrace/README.md
@@ -0,0 +1,3 @@
+# STDOUT Trace Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/stdout/stdouttrace)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/stdout/stdouttrace)
diff --git a/exporters/zipkin/README.md b/exporters/zipkin/README.md
@@ -0,0 +1,3 @@
+# Zipkin Exporter
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/zipkin)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/zipkin)
diff --git a/log/README.md b/log/README.md
@@ -0,0 +1,3 @@
+# Log API
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/log)](https://pkg.go.dev/go.opentelemetry.io/otel/log)
diff --git a/metric/README.md b/metric/README.md
@@ -0,0 +1,3 @@
+# Metric API
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/metric)](https://pkg.go.dev/go.opentelemetry.io/otel/metric)
diff --git a/sdk/README.md b/sdk/README.md
@@ -0,0 +1,3 @@
+# SDK
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk)
diff --git a/sdk/log/README.md b/sdk/log/README.md
@@ -0,0 +1,3 @@
+# Log SDK
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/log)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/log)
diff --git a/sdk/metric/README.md b/sdk/metric/README.md
@@ -0,0 +1,3 @@
+# Metric SDK
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/metric)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/metric)
diff --git a/trace/README.md b/trace/README.md
@@ -0,0 +1,3 @@
+# Trace API
+
+[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/trace)](https://pkg.go.dev/go.opentelemetry.io/otel/trace)