You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2017/10/03 10:06:02 UTC
svn commit: r1810914 -
/sling/trunk/contrib/nosql/couchbase-resourceprovider/README.md
Author: olli
Date: Tue Oct 3 10:06:02 2017
New Revision: 1810914
URL: http://svn.apache.org/viewvc?rev=1810914&view=rev
Log:
SLING-7167 Adjust READMEs
add uniform header linking to Sling project
Modified:
sling/trunk/contrib/nosql/couchbase-resourceprovider/README.md
Modified: sling/trunk/contrib/nosql/couchbase-resourceprovider/README.md
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/nosql/couchbase-resourceprovider/README.md?rev=1810914&r1=1810913&r2=1810914&view=diff
==============================================================================
--- sling/trunk/contrib/nosql/couchbase-resourceprovider/README.md (original)
+++ sling/trunk/contrib/nosql/couchbase-resourceprovider/README.md Tue Oct 3 10:06:02 2017
@@ -1,25 +1,26 @@
-Apache Sling NoSQL Couchbase Resource Provider
-==============================================
-
-Sling ResourceProvider implementation that uses [Couchbase](http://www.couchbase.com/) NoSQL database as persistence.
-
-Based on the "Apache Sling NoSQL Generic Resource Provider" and "Apache Sling NoSQL Couchbase Client".
-
-Couchbase Server 4.0 with N1QL support is required for this implementation.
-
-
-Configuration on deployment
----------------------------
-
-* To use the resource provider you have to to create a factory configuration for "Apache Sling NoSQL Couchbase Client" with clientId = ´sling-resourceprovider-couchbase´ and propert couchbase host and bucket configuration.
-* Additionally a factory configuration for "Apache Sling NoSQL Couchbase Resource Provider Factory" defines the root of the resource tree that should be stored in Couchbase
-
-
-Run integration tests
----------------------
-
-To run the integration tests you have to set up a real couchbase server and run the tests with this command line (inserting the correct parameters for couchbase host and bucket):
-
-```
-mvn -Pcouchbase-integration-test -DcouchbaseHosts=localhost:8091 -DbucketName=test integration-test
-```
+# Apache Sling NoSQL Couchbase Resource Provider
+
+This module is part of the [Apache Sling](https://sling.apache.org) project.
+
+Sling ResourceProvider implementation that uses [Couchbase](http://www.couchbase.com/) NoSQL database as persistence.
+
+Based on the "Apache Sling NoSQL Generic Resource Provider" and "Apache Sling NoSQL Couchbase Client".
+
+Couchbase Server 4.0 with N1QL support is required for this implementation.
+
+
+Configuration on deployment
+---------------------------
+
+* To use the resource provider you have to to create a factory configuration for "Apache Sling NoSQL Couchbase Client" with clientId = ´sling-resourceprovider-couchbase´ and propert couchbase host and bucket configuration.
+* Additionally a factory configuration for "Apache Sling NoSQL Couchbase Resource Provider Factory" defines the root of the resource tree that should be stored in Couchbase
+
+
+Run integration tests
+---------------------
+
+To run the integration tests you have to set up a real couchbase server and run the tests with this command line (inserting the correct parameters for couchbase host and bucket):
+
+```
+mvn -Pcouchbase-integration-test -DcouchbaseHosts=localhost:8091 -DbucketName=test integration-test
+```