Add READMEs to every package

.github/workflows/readme.yml

@@ -0,0 +1,18 @@
+name: ci
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  readme_presence:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Install zsh
+        run: sudo apt-get update; sudo apt-get install zsh
+
+      - name: Run readme.sh
+        run: ./.github/workflows/scripts/readme.sh

.github/workflows/scripts/readme.sh

@@ -0,0 +1,19 @@
+#!/bin/zsh -ex
+
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+dirs=(`find . -type f -name "go.mod" -not -path "*/internal/*" -exec dirname {} \; | sort | egrep  '^./'`)
+topdir=`pwd`
+
+for dir in $dirs; do
+	echo "checking $dir"
+
+	cd $dir
+	pwd
+	if [ ! -f "README.md" ]; then
+		echo "couldn't find README.md for $dir"
+		exit 1
+	fi
+	cd $topdir
+done

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)

bridge/opencensus/test/README.md

@@ -0,0 +1,3 @@
+# OpenTelemetry/OpenCensus Bridge Tests
+
+This package is used for internal tests only.

bridge/opentracing/test/README.md

@@ -0,0 +1,3 @@
+# OpenTelemetry/OpenTracing Bridge Tests
+
+This package is used for internal tests only.

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)