From cfa4d8c25a84d7bcb1288656ad961e00082409d0 Mon Sep 17 00:00:00 2001
From: Viktor Matanski <vmatanski@localhost.localdomain>
Date: Mon, 19 Nov 2018 11:53:32 +0200
Subject: [PATCH] updated readme and added MIT license
---
LICENSE.md | 7 +++++++
README.md | 25 ++++++++++++++++---------
2 files changed, 23 insertions(+), 9 deletions(-)
create mode 100644 LICENSE.md
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..0e3d43a
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,7 @@
+### Copyright 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
diff --git a/README.md b/README.md
index b456008..d8fc497 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,20 @@
+# VCL - Vereign Javascript Library
-# Vereign Client Library (VCL)
+1. [Introduction](#introduction)
+1. [Setup](#setup)
+1. [Usage](#usage)
+1. [License](#license)
+
+# Introduction
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
+# Setup
+
+Run `make` and get client library and iframe bundles from `javascript/dist`
+
+# Usage
+
Add library as inline script.
```html
<script type="text/javascript" src="./viamapi-client.js"/>
@@ -45,9 +56,6 @@ this.library.then(lib => {
});
```
-
-## Development
-
### Running
Run `make dev` to enter development mode. Library will be built with all Restful API endpoints and served from `localhost:9000`. If you edit JS libs code, it will be reloaded on the fly.
@@ -60,12 +68,11 @@ You can specify these URLs in the clients.
If you have to do changes in `main.go`, you need interrupt current process and do `make dev` again.
### CORS
+
Since libs and restful-api being served within different ports during the development,
it worth mention that responses from restful-api in dev mode must include `"Access-Control-Allow-Origin": "http://localhost:9000"`
and `"Access-Control-Allow-Headers": "*"` headers.
-## Building
-
-Run `make` and get client library and iframe bundles from `javascript/dist`
-
+## License
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
\ No newline at end of file
--
GitLab