Improve project description (#345)

* Improject project description * Remove "add" from link * Update docs/README.md Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> * Update docs/README.md Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> * Update docs/README.md Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
open-telemetry · Feb 4, 2022 · 0b528d3 · 0b528d3
1 parent d2a46dc
commit 0b528d3
Showing 1 changed file with 16 additions and 4 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -2,13 +2,25 @@
 
 [![Slack](https://img.shields.io/badge/slack-@cncf/otel--dotnet--auto--instr-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C01NR1YLSE7)
 
-This project provides a .NET tracer that leverages the .NET profiling APIs to support .NET instrumentation and auto-instrumentation without requiring code changes to an application.
+This project adds [OpenTelemetry instrumentation](https://opentelemetry.io/docs/concepts/instrumenting/#automatic-instrumentation)
+to .NET applications without having to modify their source code.
+
+To auto-instrument applications, the instrumentation:
+
+1. Injects and configures the [OpenTelemetry .NET SDK](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry/README.md#opentelemetry-net-sdk) into the application.
+2. Adds [OpenTelemetry Instrumentation](https://opentelemetry.io/docs/concepts/instrumenting/) to key packages and APIs used by the application.
+
+The auto-instrumentation is capable of injecting instrumentations at runtime, 
+a technique known as [monkey-patching](https://en.wikipedia.org/wiki/Monkey_patch). 
+This allows to instrument specific packages or APIs that don't provide the necessary hooks
+to generate .NET instrumentation packages.
+
+See [DESIGN.md](DESIGN.md) for an architectural overview of the project.
 
 ## Status
 
-This project is in the early stages of development starting with an initial seeding of code from the [.NET Tracer for Datadog APM](https://github.com/DataDog/dd-trace-dotnet). There is a [project board](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/projects/1) showing the current work in progress and the backlog.
+This project is in the early stages of development, starting with an initial seeding of code from the [.NET Tracer for Datadog APM](https://github.com/DataDog/dd-trace-dotnet). A [project board](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/projects/1) shows the current work in progress and the backlog.
 
-For more details about the design and roadmap see [DESIGN.md](DESIGN.md).
 
 ## Compatibility
 
@@ -18,7 +30,7 @@ supported operating systems and versions of
 and [.NET Framework](https://dotnet.microsoft.com/download/dotnet-framework)
 except for versions lower than `.NET Framework 4.6.1`.
 
-The code is automatically tested against following operating systems:
+CI tests run against the following operating systems:
 
 - Microsoft Windows Server 2019,
 - macOS Catalina 10.15,