diff --git a/packages/app-shell/README.md b/packages/app-shell/README.md index 14209b7c324362b8f1d9316e306f1fcda8b07b0b..effc10b448b88e6b8920b82b09abbea78b1d5372 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 b48d00bf76e463dcda6ee02acf69fda76de75891..ccecb0392a24def4c5f0e2398abde21091ee7221 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": {