From d96ef987310f23511db08af6822f8fffe598417c Mon Sep 17 00:00:00 2001 From: Mattia Iavarone Date: Thu, 3 Jan 2019 18:49:05 +0100 Subject: [PATCH] Add README notes about v2 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 0fc916e9..0f788b70 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ [![Build Status](https://travis-ci.org/natario1/CameraView.svg?branch=master)](https://travis-ci.org/natario1/CameraView) [![Code Coverage](https://codecov.io/gh/natario1/CameraView/branch/master/graph/badge.svg)](https://codecov.io/gh/natario1/CameraView) +*This is a new major version (v2) of the library. It includes breaking changes, signature changes and new functionality. +Keep reading if interested, or head to the legacy-v1 branch to read v1 documentation and info.* + +*The v2 version is still in beta and its API surface might still change. Functions might be renamed, +options might be removed (though they probably won't), signatures might change. If this is a problem, +please wait for the final release and keep using v1*. + +