From 8cf4a0a8dbb1c69bbc732158200bde1953c7f467 Mon Sep 17 00:00:00 2001
From: Trask Stalnaker <trask.stalnaker@gmail.com>
Date: Fri, 8 Nov 2024 07:19:09 -0800
Subject: [PATCH] Make status of this repo clearer

---
 CONTRIBUTING.md | 21 +++++++++++++++
 README.md       | 69 +++----------------------------------------------
 2 files changed, 25 insertions(+), 65 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..9a493b9
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+## Project setup
+
+The build downloads proto definitions
+from [open-telemetry/opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) and
+generates Java bindings:
+
+```shell
+./gradlew build
+```
+
+By default protos definitions will be downloaded for the latest published tag
+of `opentelemetry-proto-java`. For example, if the latest version
+is [0.20.0](https://github.com/open-telemetry/opentelemetry-proto-java/tree/v0.20.0), protos will be
+downloaded from
+the [v0.20.0 release](https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.20.0).
+This can be overridden for the build or other gradle tasks (e.g. `publishToMavenLocal`)
+with `-Prelease.version.prop`:
+
+```shell
+./gradlew build -Prelease.version.prop=1.0.0
+```
diff --git a/README.md b/README.md
index 2bf45ae..e88d52c 100644
--- a/README.md
+++ b/README.md
@@ -1,72 +1,11 @@
-# <img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OpenTelemetry Icon" width="45" height=""> Java Bindings for the OpenTelemetry Protocol (OTLP)
-
-[![Maven Central](https://img.shields.io/maven-central/v/io.opentelemetry.proto/opentelemetry-proto.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.opentelemetry.proto%22%20AND%20a:%22opentelemetry-proto%22)
-
-Java code-generation for the OpenTelemetry Protocol Buffer data model. This repository contains
-workflows and build scripts that pull releases
-from [opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) to generate and
-build Java bindings and publish them to the
-[Maven Central Repository](https://search.maven.org/artifact/io.opentelemetry.proto/opentelemetry-proto).
-
-## Published releases
-
-You can use the published releases available
-on [Maven Central](https://search.maven.org/artifact/io.opentelemetry.proto/opentelemetry-proto). To
-do so, add the following as dependencies to your build configuration and replace `{{version}}` with
-your desired version.
-
-### Maven
-
-```xml
-
-<dependency>
-  <groupId>io.opentelemetry.proto</groupId>
-  <artifactId>opentelemetry-proto</artifactId>
-  <version>{{version}}</version>
-</dependency>
-```
-
-### Gradle
-
-```kotlin
-implementation("io.opentelemetry.proto:opentelemetry-proto:{{version}}")
-```
-
-## Project setup
-
-The build downloads proto definitions
-from [open-telemetry/opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto) and
-generates Java bindings:
-
-```shell
-./gradlew build
-```
-
-By default protos definitions will be downloaded for the latest published tag
-of `opentelemetry-proto-java`. For example, if the latest version
-is [0.20.0](https://github.com/open-telemetry/opentelemetry-proto-java/tree/v0.20.0), protos will be
-downloaded from
-the [v0.20.0 release](https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.20.0).
-This can be overridden for the build or other gradle tasks (e.g. `publishToMavenLocal`)
-with `-Prelease.version.prop`:
-
-```shell
-./gradlew build -Prelease.version.prop=1.0.0
-```
-
-## Support
+# :warning: Not intended for production use :warning:
 
 The generated java bindings published from this repository are provided as-is.
 
-For generic documentation on how to use protobuf bindings,
-see [gRPC documentation](https://grpc.io/docs/languages/java/generated-code/)
-and [protobuf java documentation](https://protobuf.dev/reference/java/java-generated/).
+They are only used within the OpenTelemetry project by test suites
+and are not intended for production use.
 
-We have no intention of eventually publishing stable artifacts. If you need guarantees,
+There is no intention of eventually publishing stable artifacts. If you need any guarantees,
 please generate your own bindings,
 consulting [grpc codegen](https://grpc.io/docs/languages/java/generated-code/#codegen) and
 possibly [build.gradle.kts](build.gradle.kts)
-
-## Releasing
-
-See [RELEASING.md](./RELEASING.md)