update readme with a warning about the public API

marcdel · Oct 3, 2020 · 14fb310 · 14fb310
1 parent c7ba2b5
commit 14fb310
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,8 @@
 [![Build status badge](https://github.com/marcdel/open_telemetry_decorator/workflows/Elixir%20CI/badge.svg)](https://github.com/marcdel/open_telemetry_decorator/actions)
 [![Hex version badge](https://img.shields.io/hexpm/v/open_telemetry_decorator.svg)](https://hex.pm/packages/open_telemetry_decorator)
 
+⚠️ Caution: the public API for this project is still evolving and is not yet stable 
+
 <!-- MDOC -->
 <!-- INCLUDE -->
 A function decorator for OpenTelemetry traces.