[sling-whiteboard] branch master updated: Warn about this being experimental

[bd...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

bdelacretaz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git


The following commit(s) were added to refs/heads/master by this push:
     new 17efe58  Warn about this being experimental
17efe58 is described below

commit 17efe58ed3853e8e740a5cb45d743b14f480cfc7
Author: Bertrand Delacretaz <bd...@apache.org>
AuthorDate: Wed Jan 30 10:18:31 2019 +0100

    Warn about this being experimental
---
 jcr-wrappers/README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/jcr-wrappers/README.md b/jcr-wrappers/README.md
index 41218e3..dfeb4fa 100644
--- a/jcr-wrappers/README.md
+++ b/jcr-wrappers/README.md
@@ -5,6 +5,8 @@ This module provides a set of classes that wrap the JCR API.
 
 The wrappers just pass all calls through to the underlying implementation, they are meant to be extended to customize just the methods that need customizing.
 
+At this point this is **experimental** - the JCR API as rich and sometimes complex semantics which can be tricky to wrap properly. If this module works for your purposes that's great, but don't expect too much!
+
 Use Cases
 ----
 This can be used to interecept calls to the JCR API in a way that's transparent to the clients.
@@ -17,4 +19,4 @@ Use cases include, but are not limited to:
  
 So far we have only used this module for a limited implementation of content pre-loading as demonstrated by this module's tests.
 
-Other usages will probably need expanding this module's test coverage which is incomplete for now.
\ No newline at end of file
+Other usages will probably need expanding this module's test coverage which is incomplete for now.