From 921798e416cb44aff7078dc5e4009f9b1842bc10 Mon Sep 17 00:00:00 2001 From: Patrizio Bekerle <patrizio@bekerle.com> Date: Wed, 16 Jun 2021 11:33:11 +0200 Subject: [PATCH] Add dbp-provider usage documentation --- packages/provider/README.md | 6 ++++++ packages/provider/package.json | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/packages/provider/README.md b/packages/provider/README.md index 55cc093f..cb628e87 100644 --- a/packages/provider/README.md +++ b/packages/provider/README.md @@ -41,6 +41,12 @@ You can provide attributes (e.g. `global-name`) for components inside the provid <script type="module" src="node_modules/@dbp-toolkit/provider/dist/dbp-provider.js"></script> ``` +Or you can also use the CDN to include the component: + +```html +<script type="module" src="https://unpkg.com/@dbp-toolkit/provider@0.2.2/dist/dbp-provider.js"></script> +``` + All other components are also inherent providers (see below), so you don't really need `dbp-provider` in the shadow dom of other components. The use of `dbp-provider` is mainly suggested being used for namespacing (e.g. different languages or entry point urls on the same page) or to deliver attribute changes across different components. diff --git a/packages/provider/package.json b/packages/provider/package.json index b1c7c9d4..f7db2850 100644 --- a/packages/provider/package.json +++ b/packages/provider/package.json @@ -1,7 +1,7 @@ { "name": "@dbp-toolkit/provider", "homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/provider", - "version": "0.2.2", + "version": "0.2.3", "main": "src/index.js", "license": "LGPL-2.1-or-later", "repository": { -- GitLab