README.md: indicate that this README might be incorrect before v3

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/.gitignore b/.gitignore
index 1ff2f62381f084ce22d478fc8a48b6e7ff71e13b..cc4a89652e648d990fcc5151b8561081e4c018e0 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -58,3 +58,6 @@ target/
 
 # Virtual environment
 virt/
+
+# pytest
+.pytest_cache/

diff --git a/README.md b/README.md
index 88afde78b2e7b75fbc072c31d257cf607e0a1c1d..2a2c0c802bc4f0cd756d8d6cee940ae586d7eeb3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
 ![Icon made by Freepik from www.flaticon.com](https://lttng.org/blog/images/barectf.png)
 
+:bangbang: | ATTENTION: barectf is currently transitioning from v2 to v3. In the meantime, this README might be incorrect. New documentation will be written.
+:---: | :---
+
 [![](https://img.shields.io/pypi/v/barectf.svg)](https://pypi.python.org/pypi/barectf)
 [![Jenkins](https://img.shields.io/jenkins/s/https/ci.lttng.org/barectf_master_build.svg)](https://ci.lttng.org/job/barectf_master_build)