From 50fac13ed882fb268a1180c071580d9861c19a24 Mon Sep 17 00:00:00 2001
From: Patrizio Bekerle <patrizio@bekerle.com>
Date: Wed, 16 Jun 2021 08:39:02 +0200
Subject: [PATCH] Update app-shell usage documentation
---
packages/app-shell/README.md | 13 ++++++++++++-
packages/app-shell/package.json | 2 +-
2 files changed, 13 insertions(+), 2 deletions(-)
diff --git a/packages/app-shell/README.md b/packages/app-shell/README.md
index 14209b7c..effc10b4 100644
--- a/packages/app-shell/README.md
+++ b/packages/app-shell/README.md
@@ -12,10 +12,21 @@ npm i @dbp-toolkit/app-shell
## Usage
```html
-<dbp-app-shell src="/example.topic.metadata.json"></dbp-app-shell>
<script type="module" src="node_modules/@dbp-toolkit/app-shell/dist/dbp-app-shell.js"></script>
+<dbp-app-shell src="/example.topic.metadata.json"></dbp-app-shell>
+```
+
+Or directly via CDN:
+
+```html
+<script type="module" src="https://unpkg.com/@dbp-toolkit/app-shell@0.2.3/dist/dbp-app-shell.js"></script>
+<dbp-app-shell src="/example.topic.metadata.json"></dbp-app-shell>
```
+You need Keycloak and other parts to be in place to really make full use of the AppShell.
+Best take a look on examples like [index.html](https://gitlab.tugraz.at/dbp/esign/signature/-/blob/master/examples/dbp-signature/index.html)
+for more explanation.
+
## Attributes
- `lang` (optional, default: `de`): set to `de` or `en` for German or English
diff --git a/packages/app-shell/package.json b/packages/app-shell/package.json
index b48d00bf..ccecb039 100644
--- a/packages/app-shell/package.json
+++ b/packages/app-shell/package.json
@@ -1,7 +1,7 @@
{
"name": "@dbp-toolkit/app-shell",
"homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/app-shell",
- "version": "0.2.3",
+ "version": "0.2.4",
"main": "src/index.js",
"license": "LGPL-2.1-or-later",
"repository": {
--
GitLab