diff --git a/README.md b/README.md index d12a982..4d58985 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# jackrabbit -Nanbando-Plugin to backup jackrabbit data +# Nanbando: jackrabbit + +Nanando-Plugin which uses `phpcr` to backup and restore jackrabbit data. + +## Installation + +You can install this plugin by adding `nanbando/jackrabbit` to the `require`-section of the nanbando.json file. + +## Configuration + +```json +{ + "name": "application", + "backup": { + "cmf": { + "plugin": "jackrabbit", + "parameter": { + "jackrabbit_uri": "http://localhost:8080/server/", + "workspace": "default", + "user": "admin", + "password": "***", + "path": "/cmf" + } + }, + }, + "require": { + "nanbando/jackrabbit": "^0.1" + } +} +``` + +## Documentation + +See the official documentation on [nanbando.readthedocs.io/en/latest/plugins/index.html](https://nanbando.readthedocs.io/en/latest/plugins/index.html). diff --git a/composer.json b/composer.json index 639c6e3..85fdd49 100644 --- a/composer.json +++ b/composer.json @@ -6,7 +6,7 @@ "jackalope/jackalope-jackrabbit": "^1.2" }, "require-dev": { - "nanbando/core": "dev-master", + "nanbando/core": "^0.1|dev-master", "phpunit/phpunit": "^5.3" }, "autoload": {