From 7ff8da5af54899ad7c9506ce89abb00db842f255 Mon Sep 17 00:00:00 2001 From: Geoffrey Sneddon Date: Fri, 15 Jul 2016 19:04:41 +0100 Subject: [PATCH] Add a note about API stability and major breakages --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index 2ad46090..85dba9f2 100644 --- a/README.rst +++ b/README.rst @@ -9,6 +9,20 @@ conform to the WHATWG HTML specification, as is implemented by all major web browsers. +API Stability +------------- + +In line with `SemVer `_, we do not +guarantee API stability for 0.y.z releases. + +A few major breakages include: + +- beautifulsoup4 (bs4) requires html5lib<0.99999999 (minimum version + unknown!) + +- bleach requires >=0.999,<0.99999999 + + Usage -----