doc: improve readme (#50)

* doc: improve readme Signed-off-by: Cattī Crūdēlēs <[email protected]> * . Signed-off-by: Cattī Crūdēlēs <[email protected]> --------- Signed-off-by: Cattī Crūdēlēs <[email protected]>
wzy9607 · Aug 31, 2024 · e9921a4 · e9921a4
1 parent 89403bf
commit e9921a4
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,20 @@
-# amqp091otel
+# OpenTelemetry RabbitMQ Client Instrumentation for Golang
 
 [![ci](https://github.com/wzy9607/amqp091otel/actions/workflows/pull-request.yml/badge.svg)](https://github.com/wzy9607/amqp091otel/actions/workflows/pull-request.yml)
 [![codecov](https://codecov.io/gh/wzy9607/amqp091otel/graph/badge.svg?token=3994PBP60N)](https://codecov.io/gh/wzy9607/amqp091otel)
 
-OpenTelemetry instrumentation for [github.com/rabbitmq/amqp091-go](https://github.com/rabbitmq/amqp091-go).
+This module provides OpenTelemetry instrumentation for the Go RabbitMQ Client
+Library [github.com/rabbitmq/amqp091-go](https://github.com/rabbitmq/amqp091-go).
+
+As for now, this module only provides tracing instrumentation.
+
+## Compatibility
+
+This module supports the same go versions as the
+[opentelemetry-go project](https://github.com/open-telemetry/opentelemetry-go?tab=readme-ov-file#compatibility).
+
+## Installation
+
+```bash
+go get -u github.com/wzy9607/amqp091otel
+```