@public-ui/schema - npm Package Compare versions

Comparing version 2.0.0-rc.12 to 2.0.0-rc.13

package.json

 {
   "name": "@public-ui/schema",
-  "version": "2.0.0-rc.12",
+  "version": "2.0.0-rc.13",
   "license": "EUPL-1.2",
@@ -48,5 +48,5 @@ "homepage": "https://public-ui.github.io",
     "@types/node": "ts5.3",
-    "@typescript-eslint/eslint-plugin": "6.13.0",
-    "@typescript-eslint/parser": "6.13.0",
-    "eslint": "8.54.0",
+    "@typescript-eslint/eslint-plugin": "6.13.1",
+    "@typescript-eslint/parser": "6.13.1",
+    "eslint": "8.55.0",
     "eslint-plugin-no-loops": "0.3.0",
@@ -53,0 +53,0 @@ "typescript": "5.3.2",

README.md

@@ -1,7 +0,31 @@
-# Schema
+# KoliBri - Schema
 
-Das **Schema**-Modul beinhaltet die konkrete Spezifikation der Komponenten-Bibliothek. Dazu gehört u.a. die Liste der Tag-Names und Translation-Keys.
+The **Schema** module contains the concrete specification of the component library. This includes the list of tag names and translation keys.
 
-Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden.
+More information on **modularization** can be found in the [architecture concept](https://public-ui.github.io/docs/concepts/architecture).  
+More about the **project** can be found in the [documentation](https://public-ui.github.io/docs).
 
-Mehr zum **Projekt** kann in der [README](https://public-ui.github.io/docs) nachgelesen werden.
+## Installation
+
+You can install the KoliBri schema with `npm`, `pnpm` or `yarn`:
+
+```bash
+npm i -g @public-ui/schema
+pnpm i -g @public-ui/schema
+yarn add -g @public-ui/schema
+```
+
+## Usage
+
+The `KoliBri` object can be used to register themes and translations:
+
+```typescript
+import { KoliBri } from '@public-ui/schema';
+
+KoliBri.createTranslation('de', {
+	/* translations */
+});
+KoliBri.createTheme('default', {
+	/* component definitions */
+});
+```

No alert changes

Improved metrics

Total package byte prevSize

25695

increased by1.82%

Number of lines in readme file

32

increased by300%

No dependency changes