README.md: add warning about breaking changes

9 years ago · 3af6409eeb
parent 2d01ba7dbe
commit 3af6409eeb
1 changed files with 9 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -11,6 +11,15 @@ Documentation is at https://periph.io
 [![Gitter chat](https://badges.gitter.im/google/periph.png)](https://gitter.im/periph-io/Lobby)


+## WARNING
+
+**This library is unstable. Breaking API changes occur frequently.**
+
+If you want to use `periph.io/x/periph`, please [vendor
+periph](https://github.com/golang/go/wiki/PackageManagementTools) first and
+frequently roll.
+
+
 ## Example

 ~~~go