Add proj status, and API compatibility matrix in README.md (#945)

* add project status, and compatibility matrix

* format

* Update README.md

Co-authored-by: Reiley Yang <reyang@microsoft.com>
This commit is contained in:
Lalit Kumar Bhasin 2021-08-12 22:49:08 +05:30 коммит произвёл GitHub
Родитель 412025895e
Коммит 91215cd229
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 19 добавлений и 0 удалений

Просмотреть файл

@ -8,6 +8,25 @@ Status](https://github.com/open-telemetry/opentelemetry-cpp/actions/workflows/ci
The C++ [OpenTelemetry](https://opentelemetry.io/) client.
## Project Status
| Signal | Status | Project |
| ------- | ---------------------- | ------------------------------------------------------------------------ |
| Traces | Release Candidate | [1.0.0](https://github.com/open-telemetry/opentelemetry-cpp/milestone/9) |
| Metrics | Development paused [1] | N/A |
| Logs | Experimental [2] | N/A |
* [1]: The development of the metrics API and SDK has paused due to limited development resources, prioritization of a stable Traces release, and waiting for availability of stable Metrics ( API + SDK ) design from the OpenTelemetry specification. The current implementation can be included in build by setting `ENABLE_METRICS_PREVIEW` preprocessor macro.
* [2]: The current Log Signal Implementation is Experimental, and will change as the current OpenTelemetry Log specification matures. The current implementation can be included in build by setting `ENABLE_LOGS_PREVIEW` preprocessor macro.
## OpenTelemetry Specification Compatibility Matrix
| API Version | Core version | Contrib Version |
| ----------- |--------------|-------------------------|
| 1.0.0 | 1.0.0-rc4 | N/A [1] |
* [1]: We don't have releases for opentelemetry-cpp contrib repo. This may change in future.
## Supported C++ Versions
Code shipped from this repository generally supports the following versions of