Merge branch 'readme' into 'master'

added readme

See merge request !1

npm/package/README.md

+
+# Vereign Client Library (VCL)
+
+Vereign’s JavaScript library is an asynchronous library that allows for digitally signing your email and in-browser documents, data encryption, and key-based authentication.
+
+## Usage
+
+```js
+import { setupViamAPI } from "vcl";
+
+// setupViamAPI(divId, methodsArg, envUrl)
+function setupViamAPI(divId, methodsArg, envUrl) {
+	const connection = Penpal.connectToChild({
+	  // URL of page to load into iframe.
+	  url: envUrl,
+	  // Container to which the iframe should be appended.
+	  appendTo: document.getElementById(divId),
+	  // Methods parent is exposing to child
+	  methods: methodsArg
+	});
+
+	return connection.promise
+}	
+```
+
+```js
+// Example
+this.library = setupViamAPI(
+      "root",
+      {
+        onEvent(event) {
+          sendEvent(event);
+        }
+      },
+      this.props.configuration.api.endpoint
+);
+
+this.library.then(lib => {
+      this.listenerUUID = this.addListener({
+        callback: function(event) {
+          handleEvent(event);
+        },
+        filters: [
+          "IdentityNotLoaded",
+          "ActionConfirmedAndExecuted",
+          "Authenticated"
+        ]
+      });
+
+      lib.listIdentities().then(response => {
+        this.setState({ identities: response.data });
+      });
+    });
+}
+
+```
+
+## Installation
+
+With [npm](https://npmjs.org) do
+
+```bash
+$ npm install vcl
+```
+
+## License
+
+(MIT)
+
+Copyright (c) 2018 Vereign AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file