[RFC weston 3/4] XXX: README: Mention bits that we really want for libweston

[Emil Velikov]

From: Emil Velikov <emil.velikov at collabora.com>

---
 README | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README b/README
index b8aa2e0..e411343 100644
--- a/README
+++ b/README
@@ -161,3 +161,15 @@ major ABI-versions, except those explicitly mentioned.
 
 Weston's build may not sanely allow this yet, but this is the
 intention.
+
+XXX: Document the versioning scheme properly
+What breaks, what doesn't. When do we bump major, minor and patch.
+
+XXX: Note why should new symbols (API) be guarded by LIBWESTON_API_VERSION >= $VERSION macros.
+
+It allows us to add new features/API without any risk of being breaking things.
+
+broke when I reverted to version X" because they have explicitly requested.
+What/how ? Simple, anyone that uses the new API explicitly annotates the verion
+they which to use. Thus there won't be any issues of the sort "things broke
+when I reverted to using version X-Y" as they _explicitly_ request version X ;-)
-- 
2.8.2