From df9300ad65e7ec24ee9c3a3aee898e5918d44064 Mon Sep 17 00:00:00 2001
From: Patrizio Bekerle <patrizio@bekerle.com>
Date: Thu, 3 Dec 2020 08:04:28 +0100
Subject: [PATCH] Add more documentation (#36)
---
packages/auth/README.md | 8 ++++++++
packages/auth/package.json | 2 +-
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/packages/auth/README.md b/packages/auth/README.md
index e1105c6c..c9d99d38 100644
--- a/packages/auth/README.md
+++ b/packages/auth/README.md
@@ -1,11 +1,18 @@
# Auth Web Components
+You can install the components via npm:
+
+```bash
+npm i @dbp-toolkit/auth
+```
+
## Keycloak Component
### Usage
```html
<dbp-auth-keycloak url="https://auth.tugraz.at/auth" realm="tugraz" client-id="some-id"></dbp-auth-keycloak>
+<script type="module" src="node_modules/@dbp-toolkit/auth/dist/dbp-auth.js"></script>
```
### Attributes
@@ -41,6 +48,7 @@
```html
<dbp-login-button></dbp-login-button>
+<script type="module" src="node_modules/@dbp-toolkit/auth/dist/dbp-auth.js"></script>
```
## Local development
diff --git a/packages/auth/package.json b/packages/auth/package.json
index 3b6fa7f8..b74abb0d 100644
--- a/packages/auth/package.json
+++ b/packages/auth/package.json
@@ -1,7 +1,7 @@
{
"name": "@dbp-toolkit/auth",
"homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/auth",
- "version": "0.1.1",
+ "version": "0.1.2",
"main": "src/index.js",
"license": "LGPL-2.1-or-later",
"publishConfig": {
--
GitLab