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-couchbase-resourceprovider.git
commit e51e4f3271c9a8a9b2cc5f754b8b9b765e9526db Author: Oliver Lietz <[email protected]> AuthorDate: Tue Oct 3 10:06:02 2017 +0000 SLING-7167 Adjust READMEs add uniform header linking to Sling project git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1810914 13f79535-47bb-0310-9956-ffa450edef68 --- README.md | 51 ++++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 6b88a77..2c9e5d1 100644 --- a/README.md +++ b/README.md @@ -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 +``` -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
