From 702043bf096508543fde71293095cb63e22ad1a2 Mon Sep 17 00:00:00 2001 From: Martin Oppitz <6279703+deleonio@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:26:00 +0100 Subject: [PATCH] Add badges to README files for various adapters and themes Refs: #7186 --- packages/adapters/angular/v15/README.md | 8 +++++ packages/adapters/angular/v16/README.md | 8 +++++ packages/adapters/angular/v17/README.md | 8 +++++ packages/adapters/angular/v18/README.md | 8 +++++ packages/adapters/hydrate/README.md | 8 +++++ packages/adapters/preact/README.md | 8 +++++ packages/adapters/react-standalone/README.md | 8 +++++ packages/adapters/react/README.md | 8 +++++ packages/adapters/solid/README.md | 12 +++++-- packages/adapters/vaadin/README.md | 8 +++++ packages/adapters/vue/README.md | 10 +++++- packages/components/README.md | 8 +++++ packages/designer/README.md | 8 +++++ packages/samples/angular/README.md | 8 +++++ packages/samples/react/README.md | 8 +++++ packages/themes/README.md | 8 +++++ packages/themes/default/README.md | 8 +++++ packages/themes/ecl/README.md | 8 +++++ packages/themes/itzbund/README.md | 8 +++++ packages/tools/kolibri-cli/README.md | 9 +++++ packages/tools/visual-tests/README.md | 36 +++++++++++++++----- 21 files changed, 192 insertions(+), 11 deletions(-) diff --git a/packages/adapters/angular/v15/README.md b/packages/adapters/angular/v15/README.md index ad61a2c751..409ea793dc 100644 --- a/packages/adapters/angular/v15/README.md +++ b/packages/adapters/angular/v15/README.md @@ -1,5 +1,13 @@ # Angular-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/angular-v15)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/angular-v15)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/angular-v15)](https://www.npmjs.com/package/@public-ui/angular-v15) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/angular-v15)](https://bundlephobia.com/result?p=@public-ui/angular-v15) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + Das [**Angular**](https://angular.io)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek. Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden. diff --git a/packages/adapters/angular/v16/README.md b/packages/adapters/angular/v16/README.md index ad61a2c751..498a73d914 100644 --- a/packages/adapters/angular/v16/README.md +++ b/packages/adapters/angular/v16/README.md @@ -1,5 +1,13 @@ # Angular-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/angular-v16)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/angular-v16)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/angular-v16)](https://www.npmjs.com/package/@public-ui/angular-v16) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/angular-v16)](https://bundlephobia.com/result?p=@public-ui/angular-v16) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + Das [**Angular**](https://angular.io)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek. Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden. diff --git a/packages/adapters/angular/v17/README.md b/packages/adapters/angular/v17/README.md index ad61a2c751..585226b41c 100644 --- a/packages/adapters/angular/v17/README.md +++ b/packages/adapters/angular/v17/README.md @@ -1,5 +1,13 @@ # Angular-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/angular-v17)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/angular-v17)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/angular-v17)](https://www.npmjs.com/package/@public-ui/angular-v17) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/angular-v17)](https://bundlephobia.com/result?p=@public-ui/angular-v17) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + Das [**Angular**](https://angular.io)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek. Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden. diff --git a/packages/adapters/angular/v18/README.md b/packages/adapters/angular/v18/README.md index ad61a2c751..9ac10e78a2 100644 --- a/packages/adapters/angular/v18/README.md +++ b/packages/adapters/angular/v18/README.md @@ -1,5 +1,13 @@ # Angular-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/angular-v18)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/angular-v18)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/angular-v18)](https://www.npmjs.com/package/@public-ui/angular-v18) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/angular-v18)](https://bundlephobia.com/result?p=@public-ui/angular-v18) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + Das [**Angular**](https://angular.io)-Modul ist der Framework-Adapter für die Komponenten-Bibliothek. Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden. diff --git a/packages/adapters/hydrate/README.md b/packages/adapters/hydrate/README.md index 22c6f6b1fa..2b4e940566 100644 --- a/packages/adapters/hydrate/README.md +++ b/packages/adapters/hydrate/README.md @@ -1,5 +1,13 @@ # KoliBri - Hydrate-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/hydrate)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/hydrate)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/hydrate)](https://www.npmjs.com/package/@public-ui/hydrate) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/hydrate)](https://bundlephobia.com/result?p=@public-ui/hydrate) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation Provide an adapter for Server Side Rendering of KoliBri components. diff --git a/packages/adapters/preact/README.md b/packages/adapters/preact/README.md index 1ed8d41e19..6108fbf1b7 100644 --- a/packages/adapters/preact/README.md +++ b/packages/adapters/preact/README.md @@ -1,5 +1,13 @@ # KoliBri - Preact-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/react)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/react)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/react)](https://www.npmjs.com/package/@public-ui/react) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/react)](https://bundlephobia.com/result?p=@public-ui/themes) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + The [Preact](https://github.com/preactjs/preact) adapter is a wrapper around the React adapter. Please refer to the [React adapter documentation](../react/README.md) for more information. ⚠️ Preact support is currently considered experimental. diff --git a/packages/adapters/react-standalone/README.md b/packages/adapters/react-standalone/README.md index b2d006fee2..45fc236646 100644 --- a/packages/adapters/react-standalone/README.md +++ b/packages/adapters/react-standalone/README.md @@ -1,5 +1,13 @@ # KoliBri - Standalone React-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/react-standalone)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/react-standalone)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/react-standalone)](https://www.npmjs.com/package/@public-ui/react-standalone) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/react-standalone)](https://bundlephobia.com/result?p=@public-ui/react-standalone) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation Provide an adapter for [React](https://reactjs.org) to use the KoliBri components, without the need for a build/bundle process. diff --git a/packages/adapters/react/README.md b/packages/adapters/react/README.md index 2f783cd844..65eca5b384 100644 --- a/packages/adapters/react/README.md +++ b/packages/adapters/react/README.md @@ -1,5 +1,13 @@ # KoliBri - React-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/react)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/react)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/react)](https://www.npmjs.com/package/@public-ui/react) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/react)](https://bundlephobia.com/result?p=@public-ui/react) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation Provide an adapter for [React](https://reactjs.org) to use the KoliBri components. diff --git a/packages/adapters/solid/README.md b/packages/adapters/solid/README.md index b3e2289867..b7c975c4fe 100644 --- a/packages/adapters/solid/README.md +++ b/packages/adapters/solid/README.md @@ -1,5 +1,13 @@ # KoliBri - Solid-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/solid)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/solid)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/solid)](https://www.npmjs.com/package/@public-ui/solid) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/solid)](https://bundlephobia.com/result?p=@public-ui/solid) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation Provide an adapter for [SolidJS](https://www.solidjs.com/) to use the KoliBri components. @@ -16,12 +24,12 @@ yarn add -g @public-ui/solid ## Usage -First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/themes) and create a Solid root: +First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/solid) and create a Solid root: ```ts import { defineCustomElements } from '@public-ui/components/dist/loader'; import { register } from '@public-ui/components'; -import { DEFAULT } from '@public-ui/themes'; +import { DEFAULT } from '@public-ui/solid'; register(DEFAULT, defineCustomElements) .then(() => { diff --git a/packages/adapters/vaadin/README.md b/packages/adapters/vaadin/README.md index f5701e04c3..f103afcd2a 100644 --- a/packages/adapters/vaadin/README.md +++ b/packages/adapters/vaadin/README.md @@ -1,5 +1,13 @@ # Vaadin-Adapter for KoliBri +[![npm](https://img.shields.io/npm/v/@public-ui/vaadin)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/vaadin)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/vaadin)](https://www.npmjs.com/package/@public-ui/vaadin) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/vaadin)](https://bundlephobia.com/result?p=@public-ui/vaadin) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Open points | Feature | Status | diff --git a/packages/adapters/vue/README.md b/packages/adapters/vue/README.md index 4ade14b124..8f47ecc114 100644 --- a/packages/adapters/vue/README.md +++ b/packages/adapters/vue/README.md @@ -1,5 +1,13 @@ # KoliBri - Vue-Adapter +[![npm](https://img.shields.io/npm/v/@public-ui/vue)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/vue)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/vue)](https://www.npmjs.com/package/@public-ui/vue) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/vue)](https://bundlephobia.com/result?p=@public-ui/vue) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation Provide an adapter for [Vue](https://vuejs.org/) to use the KoliBri components. @@ -16,7 +24,7 @@ yarn add -g @public-ui/vue ## Usage -First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/themes) and create a Vue app: +First, initialize KoliBri with a [theme](https://github.com/public-ui/kolibri/tree/develop/packages/vue) and create a Vue app: ```ts import { createApp } from 'vue'; diff --git a/packages/components/README.md b/packages/components/README.md index 576438ed1f..5750d0bbb6 100644 --- a/packages/components/README.md +++ b/packages/components/README.md @@ -1,5 +1,13 @@ # Components (Library) +[![npm](https://img.shields.io/npm/v/@public-ui/components)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/components)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/components)](https://www.npmjs.com/package/@public-ui/components) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/components)](https://bundlephobia.com/result?p=@public-ui/components) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + Das **Components**-Modul beinhaltet **alle** zur Komponenten-Bibliothek gehörenden **Web Components**. Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden. diff --git a/packages/designer/README.md b/packages/designer/README.md index 51cbfc2d9a..42c6564a9f 100644 --- a/packages/designer/README.md +++ b/packages/designer/README.md @@ -1,5 +1,13 @@ # KoliBri - Designer +[![npm](https://img.shields.io/npm/v/@public-ui/designer)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/designer)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/designer)](https://www.npmjs.com/package/@public-ui/designer) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/designer)](https://bundlephobia.com/result?p=@public-ui/designer) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation The designer is a tool that helps with creating and adjusting [KoliBri themes](https://github.com/public-ui/kolibri/tree/develop/packages/themes). diff --git a/packages/samples/angular/README.md b/packages/samples/angular/README.md index 9ca0604dc2..5bca60fb97 100644 --- a/packages/samples/angular/README.md +++ b/packages/samples/angular/README.md @@ -1,5 +1,13 @@ # Angular +[![npm](https://img.shields.io/npm/v/@public-ui/sample-angular)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/sample-angular)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/sample-angular)](https://www.npmjs.com/package/@public-ui/sample-angular) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/sample-angular)](https://bundlephobia.com/result?p=@public-ui/sample-angular) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.0. ## Development server diff --git a/packages/samples/react/README.md b/packages/samples/react/README.md index 6ef62333be..fe577e3f29 100644 --- a/packages/samples/react/README.md +++ b/packages/samples/react/README.md @@ -1,5 +1,13 @@ # KoliBri - React Sample App +[![npm](https://img.shields.io/npm/v/@public-ui/sample-react)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/sample-react)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/sample-react)](https://www.npmjs.com/package/@public-ui/sample-react) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/sample-react)](https://bundlephobia.com/result?p=@public-ui/sample-react) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation Showcase of all KoliBri components in a React application. diff --git a/packages/themes/README.md b/packages/themes/README.md index 1140604ca1..7127cd66b8 100644 --- a/packages/themes/README.md +++ b/packages/themes/README.md @@ -1,5 +1,13 @@ # KoliBri - Themes +[![npm](https://img.shields.io/npm/v/@public-ui/themes)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/themes)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/themes)](https://www.npmjs.com/package/@public-ui/themes) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/themes)](https://bundlephobia.com/result?p=@public-ui/themes) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + The **Themes** module contains numerous themes (style guides) for the component library. They can be loaded in combination with the Components module. You can read more about **modularization** in the [architecture concept](https://public-ui.github.io/docs/concepts/architecture). diff --git a/packages/themes/default/README.md b/packages/themes/default/README.md index a0defd8b89..5647ac3892 100644 --- a/packages/themes/default/README.md +++ b/packages/themes/default/README.md @@ -1,5 +1,13 @@ # Public UI - Default-Theme +[![npm](https://img.shields.io/npm/v/@public-ui/theme-default)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/theme-default)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/theme-default)](https://www.npmjs.com/package/@public-ui/theme-default) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/theme-default)](https://bundlephobia.com/result?p=@public-ui/theme-default) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + This is the default theme for the [Public UI web component library](https://public-ui.github.io). You can customize this theme by using `css variables` or by creating a new theme. ## Integration in React diff --git a/packages/themes/ecl/README.md b/packages/themes/ecl/README.md index 07242025f0..3a7157c401 100644 --- a/packages/themes/ecl/README.md +++ b/packages/themes/ecl/README.md @@ -1,5 +1,13 @@ # KoliBri - ECL-Themes +[![npm](https://img.shields.io/npm/v/@public-ui/theme-ecl)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/theme-ecl)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/theme-ecl)](https://www.npmjs.com/package/@public-ui/theme-ecl) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/theme-ecl)](https://bundlephobia.com/result?p=@public-ui/theme-ecl) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation The ECL themes provide styling according to the Styleguides of the European Commission and European Union for KoliBri-Components. diff --git a/packages/themes/itzbund/README.md b/packages/themes/itzbund/README.md index c982346a8b..a5b809e4be 100644 --- a/packages/themes/itzbund/README.md +++ b/packages/themes/itzbund/README.md @@ -1,5 +1,13 @@ # KoliBri - ITZBund-Theme +[![npm](https://img.shields.io/npm/v/@public-ui/theme-itzbund)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/theme-itzbund)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/theme-itzbund)](https://www.npmjs.com/package/@public-ui/theme-itzbund) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/theme-itzbund)](https://bundlephobia.com/result?p=@public-ui/theme-itzbund) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation The theme provides styling according to the ITZBund-Styleguides for KoliBri-Components. diff --git a/packages/tools/kolibri-cli/README.md b/packages/tools/kolibri-cli/README.md index 28213be045..132a56c5b3 100644 --- a/packages/tools/kolibri-cli/README.md +++ b/packages/tools/kolibri-cli/README.md @@ -1,5 +1,13 @@ # KoliBri - CLI-Tools +[![npm](https://img.shields.io/npm/v/@public-ui/kolibri-cli)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/kolibri-cli)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/kolibri-cli)](https://www.npmjs.com/package/@public-ui/kolibri-cli) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/kolibri-cli)](https://bundlephobia.com/result?p=@public-ui/kolibri-cli) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation The `KoliBri` CLI-Tools are a collection of tools to support the development with `KoliBri` components. @@ -45,6 +53,7 @@ Commands: ``` ### Info + With the `info` command you can show the current system and KoliBri package information. This command is mainly needed for our bug issue templates. diff --git a/packages/tools/visual-tests/README.md b/packages/tools/visual-tests/README.md index e600c00a0d..a37d472da3 100644 --- a/packages/tools/visual-tests/README.md +++ b/packages/tools/visual-tests/README.md @@ -1,5 +1,13 @@ # KoliBri - Visual Tests +[![npm](https://img.shields.io/npm/v/@public-ui/visual-tests)](https://www.npmjs.com/package/@public-ui/components) +[![license](https://img.shields.io/npm/l/@public-ui/visual-tests)](https://github.com/public-ui/kolibri/blob/main/LICENSE) +[![downloads](https://img.shields.io/npm/dt/@public-ui/visual-tests)](https://www.npmjs.com/package/@public-ui/visual-tests) +[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues) +[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls) +[![size](https://img.shields.io/bundlephobia/min/@public-ui/visual-tests)](https://bundlephobia.com/result?p=@public-ui/visual-tests) +![contributors](https://img.shields.io/github/contributors/public-ui/kolibri) + ## Motivation The `KoliBri` Visual Tests provide a way to add visual regression testing to **theme** modules. @@ -7,11 +15,23 @@ It takes screenshots of every component defined in the [React Sample App](https: ## Installation +It is recommended to configure NPM via `.npmrc`: + +```bash +# - npm +engine-strict=true +save-exact=true + +# - pnpm +shamefully-hoist=true # this is required for the visual tests to work +workspace-concurrency=1 +``` + You can install the `KoliBri` Visual Tests with `npm`, `pnpm` or `yarn`: ```bash npm i -D @public-ui/visual-tests -pnpm i -D @public-ui/visual-tests +pnpm i -D @public-ui/visual-tests # recommended yarn add -D @public-ui/visual-tests ``` @@ -21,17 +41,17 @@ Add the following npm scripts to the theme's `package.json`: ```json { - "scripts": { - "test": "THEME_MODULE=src/index THEME_EXPORT=THEME_NAME kolibri-visual-test", - "test-update": "THEME_MODULE=src/index THEME_EXPORT=THEME_NAME kolibri-visual-test --update-snapshots", - } + "scripts": { + "test": "THEME_MODULE=src/index THEME_EXPORT=THEME_NAME kolibri-visual-test", + "test-update": "THEME_MODULE=src/index THEME_EXPORT=THEME_NAME kolibri-visual-test --update-snapshots" + } } ``` -* `THEME_MODULE` defines the relative path to the TypeScript module containing the the theme definitions. Without file extension. -* `THEME_EXPERT` defines the name of the export within the the module. (e.g., `export const THEME_NAME = {/**/};`) Defaults to `default`. +- `THEME_MODULE` defines the relative path to the TypeScript module containing the the theme definitions. Without file extension. +- `THEME_EXPERT` defines the name of the export within the the module. (e.g., `export const THEME_NAME = {/**/};`) Defaults to `default`. Run the tests with `npm test`. The first time, this will create a new folder `snapshots` which is supposed to be committed to the repository. In the following runs, new screenshots will be compared to this reference. -To update the reference screenshots call `npm run test-update`. \ No newline at end of file +To update the reference screenshots call `npm run test-update`.