From c14071bae3a34e5e34e8b24d2c4f50c05dfb6b18 Mon Sep 17 00:00:00 2001
From: Patrizio Bekerle <patrizio@bekerle.com>
Date: Thu, 30 Sep 2021 08:32:00 +0200
Subject: [PATCH] Move and add provider-root documentation
---
packages/app-shell/README.md | 8 ++++----
packages/app-shell/package.json | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/packages/app-shell/README.md b/packages/app-shell/README.md
index c6bbfad1..dc2694a1 100644
--- a/packages/app-shell/README.md
+++ b/packages/app-shell/README.md
@@ -27,12 +27,12 @@ You need Keycloak and other parts to be in place to really make full use of the
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.
-You need to set the `provider-root` attribute for the app-shell to "terminate" all provider events.
-If you don't want to set the app-shell as `provider-root` then you need to set the attributes `auth`,
-`requested-login-status` and `analytics-event` as attribute for the app-shell or in a `dbp-provider` above it.
-
## Attributes
+- `provider-root` (optional): You need to set the `provider-root` attribute for the app-shell to "terminate" all provider events
+ - If you don't want to set the app-shell as `provider-root` then you need to set the attributes `auth`,
+ `requested-login-status` and `analytics-event` as attribute for the app-shell or in a `dbp-provider` above it
+ - example `<dbp-app-shell provider-root></dbp-app-shell>`
- `lang` (optional, default: `de`): set to `de` or `en` for German or English
- example `<dbp-app-shell lang="de"></dbp-app-shell>`
- `src`: The path to a topic metadata file (json)
diff --git a/packages/app-shell/package.json b/packages/app-shell/package.json
index cfafb252..59f9c52a 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.6",
+ "version": "0.2.7",
"main": "src/index.js",
"license": "LGPL-2.1-or-later",
"repository": {
--
GitLab