changed README

1 files changed, 28 insertions, 0 deletions

diff --git a/README b/README
index e69de29..0338069 100644
--- a/README
+++ b/README
@@ -0,0 +1,28 @@
+Einfach Signieren:
+
+Einfach Signieren bietet eine JavaScript Schnittstelle mit der sich einfach mit einer Buergerkarte signierte PDF Dokumente erzeugen lassen.
+
+Inkludieren der JavaScript Bibliothek:
+
+<script type="text/javascript" src="http://demo.egiz.gv.at/simpleSign/pdfas.js"></script>
+
+Diese Bibliothek erzeugt ein JS Object pdfAs. Dieses Object hat zwei Funktionen signText und signPdf.
+
+signText wird verwendet um einfach Text zu signieren, dabei wird automatisch ein PDF Dokument erzeugt, welches den Text als Inhalt hat:
+
+var op = {
+	content: "Der zu signierende Text", // Diese Eigenschaft is optional, wenn ausgelassen wird dem Benutzer ein Texteingabefeld gezeigt. Dies ist der Inhalt der signiert werden soll.
+	connector: "bku", // Diese Eigenschaft is optional, wenn ausgelassen wird dem Benutzer gefragt. Moegliche Werte sind: "bku" -> Signatur mit der lokalen BKU, "onlinebku" -> Signatur mit der online BKU, "mobilebku" -> Signatur mit der Handy Signatur
+	uiId: "exampleDiv" // Diese Eigenschaft is optional, wenn ausgelassen wird ein Overlay erzeugt. Dies ist die id eines div elements in das das iframe zur Benutzerinteraktion eingefuegt werden soll.
+};
+pdfAs.signText(op, function(error, cause) { //fehler error aufgetreten wegen cause }, function(pdfurl) { //signiertes Dokument liegt bei pdfurl });
+
+
+signPdf wird verwendet um ein PDF Dokument zu signieren:
+
+var op = {
+	content: "http://www.example.com/test.pdf", // Diese Eigenschaft is optional, wenn ausgelassen wird dem Benutzer ein File Upload angezeigt. Dies ist eine URL zum PDF Dokument welches signiert werden soll.
+	connector: "bku", // Diese Eigenschaft is optional, wenn ausgelassen wird dem Benutzer gefragt. Moegliche Werte sind: "bku" -> Signatur mit der lokalen BKU, "onlinebku" -> Signatur mit der online BKU, "mobilebku" -> Signatur mit der Handy Signatur
+	uiId: "exampleDiv" // Diese Eigenschaft is optional, wenn ausgelassen wird ein Overlay erzeugt. Dies ist die id eines div elements in das das iframe zur Benutzerinteraktion eingefuegt werden soll.
+};
+pdfAs.signPdf(op, function(error, cause) { //fehler error aufgetreten wegen cause }, function(pdfurl) { //signiertes Dokument liegt bei pdfurl });