libsheepy

commit 0f6cab0bf0b5f99eb364887f972e2664499932b9
parent 62d2b017ebde455fc1db46e5e79bbade70267712
Author: Remy Noulin <loader2x@gmail.com>
Date:   Wed, 13 May 2020 08:11:52 +0200

update readme to clarify versioning

README.md | 6 ++++++
1 file changed, 6 insertions(+)

Diffstat:
M
README.md
 | 
6
++++++

1 file changed, 6 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -13,6 +13,12 @@ libsheepy is C library for handling text files and strings.
 Status: __libsheepy and libsheepyObject implemented__
 
 The API in libsheepy.h and libsheepyObject.h is stable but not yet completely tested.
+Current API is compatible with future version of libsheepy and will be changed only if a serious bug is found (rare).
+
+The version number are x.Major.Minor.Patch and is updated like this:
+- when Patch changes for bug fixes or small changes in documentation, build scripts, ...
+- when Minor changes, the API is extended only (new functions, ...)
+- when Major changes, the API is changed in backward compatible way (rare)
 
 Future: (mainly speed improvements)
 - optimize memory management