From 97b6eab8d97e546a126a12594bd35681f6c13a72 Mon Sep 17 00:00:00 2001
From: Ralf Claussnitzer <ralf.claussnitzer@slub-dresden.de>
Date: Sat, 6 Dec 2014 12:29:12 +0100
Subject: [PATCH] Adds building and deployment notes

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index abd902d..f366c0d 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,18 @@
 
 Implements a file handler class for [sword-fedora](https://github.com/slub/sword-fedora)
 SWORD server which handles deposits of media type `application/vnd.qucosa.mets+xml`.
+
+## Building
+
+The Qucosa SWORD file handler is an extension to sword-fedora. For compilation the sword-fedora
+classes have to be installed in your local Maven repository.
+
+To achieve this, simply clone [sword-fedora](https://github.com/slub/sword-fedora) and run
+`mvn install`.
+
+## Deployment
+
+Make sure the Qucosa SWORD file handler Jar is present in your sword-fedora deployments class path.
+Then add `<handler class="org.purl.sword.server.fedora.fileHandlers.QucosaMETSFileHandler"/>` to the
+`<file_handlers` section in the `properties.xml` you use for configuring the SWORD server.
+