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-mongodb-resourceprovider.git
commit 186f90e5086057be5afdda019df00dc68d23d4ad Author: Oliver Lietz <[email protected]> AuthorDate: Tue Oct 3 10:06:29 2017 +0000 SLING-7167 Adjust READMEs add uniform header linking to Sling project git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1810917 13f79535-47bb-0310-9956-ffa450edef68 --- README.md | 49 +++++++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index eb9f53d..5910107 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,25 @@ -Apache Sling NoSQL MongoDB Resource Provider -============================================ - -Sling ResourceProvider implementation that uses [MongoDB](https://www.mongodb.org/) NoSQL database as persistence. - -Based on the "Apache Sling NoSQL Generic Resource Provider". - -All resource data is stored in one MongoDB database and one collection, using the path of the resource as "_id" property. - - -Configuration on deployment ---------------------------- - -* Create a factory configuration for "Apache Sling NoSQL MongoDB Resource Provider Factory" to define the root of the resource tree that should be stored in MongoDB, and MongoDB connection string, database name and collection name. - - -Run integration tests ---------------------- - -To run the integration tests you have to set up a real MongoDB server and run the tests with this command line (inserting the correct parameters): - -``` -mvn -Pmongodb-integration-test -DconnectionString=localhost:27017 -Ddatabase=sling -Dcollection=resources integration-test -``` +# Apache Sling NoSQL MongoDB Resource Provider + +This module is part of the [Apache Sling](https://sling.apache.org) project. + +Sling ResourceProvider implementation that uses [MongoDB](https://www.mongodb.org/) NoSQL database as persistence. + +Based on the "Apache Sling NoSQL Generic Resource Provider". + +All resource data is stored in one MongoDB database and one collection, using the path of the resource as "_id" property. + + +Configuration on deployment +--------------------------- + +* Create a factory configuration for "Apache Sling NoSQL MongoDB Resource Provider Factory" to define the root of the resource tree that should be stored in MongoDB, and MongoDB connection string, database name and collection name. + + +Run integration tests +--------------------- + +To run the integration tests you have to set up a real MongoDB server and run the tests with this command line (inserting the correct parameters): + +``` +mvn -Pmongodb-integration-test -DconnectionString=localhost:27017 -Ddatabase=sling -Dcollection=resources integration-test +``` -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
