Disclamer for breaking changes

lucapette · Jun 25, 2017 · 9d10621 · 9d10621
1 parent 935f2bb
commit 9d10621
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,13 @@
 
 `fakedata` is a small command line utility that generates random data.
 
+Please **note** you're reading the documentation of an unreleased version of
+`fakedata` which differs quite a lot from the latest stable release. We're about
+to release version [1.0.0](https://github.com/lucapette/fakedata/issues/44) that
+has some breaking changes. If you're running `fakedata v0.6.0` (you can find out
+with `fakedata --version`, then please refer to its
+[docs](https://github.com/lucapette/fakedata/tree/v0.6.0).
+
 # Table Of Contents
 
 - [Overview](#overview)