You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2017/10/18 23:26:47 UTC

[sling-org-apache-sling-nosql-generic] 38/38: SLING-7167 Adjust READMEs

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

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

commit 8e9796f29fe8dd754af8b1275c3e50978356232d
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Tue Oct 3 10:06:12 2017 +0000

    SLING-7167 Adjust READMEs
    
    add uniform header linking to Sling project
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1810915 13f79535-47bb-0310-9956-ffa450edef68
---
 README.md | 33 +++++++++++++++++----------------
 1 file changed, 17 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 3c2efba..4e6c687 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,17 @@
-Apache Sling NoSQL Generic Resource Provider
-============================================
-
-Generic implementation of a Sling ResourceProvider that helps writing ResourceProviders using NoSQL databases as persistence.
-
-The generic implementation helps mapping the resource data to document-oriented key-value NoSQL databases like MongoDB or Couchbase.
-
-Features:
-
-* Defines a simplified "NoSqlAdapter" concept that is implemented for each NoSQL database. It boils down to simple get/put/list operations. Query support is optional.
-* Complete implementation of Resource, ResourceProvider, ResourceProviderFactory and ValueMap based on the NoSqlAdapter
-* "Transaction management" of Sling CRUD (commit/revert methods) is implemented
-* ValueMap supports String, Integer, Long, Double, Date, Calendar and InputStream/byte\[\] (binary data) and arrays of them. Date/Calendar and binary data is serialized to a string before storing, so the NoSQL databases have not to support them directly.
-* Sends resource notifications via OSGi EventAdmin
-* Provides a "tests" JAR that can be used for integration tests with NoSQL databases to test the own adapter implementation
-* Can be mounted as root provider without any JCR at all
+# Apache Sling NoSQL Generic Resource Provider
+
+This module is part of the [Apache Sling](https://sling.apache.org) project.
+
+Generic implementation of a Sling ResourceProvider that helps writing ResourceProviders using NoSQL databases as persistence.
+
+The generic implementation helps mapping the resource data to document-oriented key-value NoSQL databases like MongoDB or Couchbase.
+
+Features:
+
+* Defines a simplified "NoSqlAdapter" concept that is implemented for each NoSQL database. It boils down to simple get/put/list operations. Query support is optional.
+* Complete implementation of Resource, ResourceProvider, ResourceProviderFactory and ValueMap based on the NoSqlAdapter
+* "Transaction management" of Sling CRUD (commit/revert methods) is implemented
+* ValueMap supports String, Integer, Long, Double, Date, Calendar and InputStream/byte\[\] (binary data) and arrays of them. Date/Calendar and binary data is serialized to a string before storing, so the NoSQL databases have not to support them directly.
+* Sends resource notifications via OSGi EventAdmin
+* Provides a "tests" JAR that can be used for integration tests with NoSQL databases to test the own adapter implementation
+* Can be mounted as root provider without any JCR at all

-- 
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.