cyrilix
/
goupnp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add notes about v2alpha.

This commit is contained in:
John Beisley 2022-03-24 18:38:33 +00:00 committed by Huin
parent 59a727e571
commit db322868c5
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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.