From db322868c545ab5bec64a05215ce47a5f3277687 Mon Sep 17 00:00:00 2001 From: John Beisley Date: Thu, 24 Mar 2022 18:38:33 +0000 Subject: [PATCH] Add notes about v2alpha. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index cd83797..49bd038 100644 --- a/README.md +++ b/README.md @@ -63,3 +63,14 @@ func init() { goupnp.CharsetReaderFault = charset.NewReaderLabel } ``` + +## `v2alpha` + +The `v2alpha` subdirectory contains experimental work on a version 2 API. The plan is to eventually +create a `v2` subdirectory with a stable version of the version 2 API. The v1 API will stay where +it currently is. + +> NOTE: +> +> * `v2alpha` will be deleted one day, so don't rely on it always existing. +> * `v2alpha` will have API breaking changes, even with itself.