Author: olli Date: Tue Oct 3 10:06:29 2017 New Revision: 1810917 URL: http://svn.apache.org/viewvc?rev=1810917&view=rev Log: SLING-7167 Adjust READMEs
add uniform header linking to Sling project Modified: sling/trunk/contrib/nosql/mongodb-resourceprovider/README.md Modified: sling/trunk/contrib/nosql/mongodb-resourceprovider/README.md URL: http://svn.apache.org/viewvc/sling/trunk/contrib/nosql/mongodb-resourceprovider/README.md?rev=1810917&r1=1810916&r2=1810917&view=diff ============================================================================== --- sling/trunk/contrib/nosql/mongodb-resourceprovider/README.md (original) +++ sling/trunk/contrib/nosql/mongodb-resourceprovider/README.md Tue Oct 3 10:06:29 2017 @@ -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 +```