@jungherz-de/glasskit 1.3.4 → 1.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -7,17 +7,31 @@ GlassKit uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
8
  ---
9
9
 
10
- ## [1.3.4] – 2026-03-29
10
+ ## [1.3.5] – 2026-04-04
11
11
 
12
12
  ### Added
13
13
 
14
+ - **`SKILL.md` – AI-optimized component reference** – a structured, machine-readable reference document designed for LLMs, AI copilots, and code-generation tools
15
+ - Copy-paste-ready HTML for all 22 components with exact nesting and BEM hierarchy
16
+ - Complete design token tables (colors, surfaces, borders, blur, radii, spacing, shadows, typography)
17
+ - State class reference – clear mapping of `is-active`, `is-open`, `is-visible`, `:checked`, `:focus`, `:disabled` to their components
18
+ - 6 composition patterns – full page layouts: Login, Dashboard, Form, Modal confirmation, Settings, Progress + Toast
19
+ - Common mistakes & corrections table – prevents frequent AI-generated errors
20
+ - Quick reference table – all components with modifiers at a glance
21
+ - Utility class reference with exact gap/margin values
22
+ - Web Components / Shadow DOM usage guide
23
+ - Custom theming instructions
14
24
  - **Visual preview for Tab-Bar** in `docs.html` and `de/docs.html` – live rendered tab bar with 4 tabs (Home, Documents with badge, Upload, Settings)
15
25
  - **Visual preview for Toast** in `docs.html` and `de/docs.html` – static success toast rendered inline
16
26
  - **HTML code example for Status Notice** in `docs.html` and `de/docs.html` – was previously preview-only without code snippet
17
27
 
18
28
  ### Changed
19
29
 
20
- - Version references updated to 1.3.4 across all files
30
+ - **README.md** – new “AI / LLM Reference” section documenting `SKILL.md` purpose and usage, “AI-ready” added to “Why GlassKit?”
31
+ - **Project structure** in README updated to include `SKILL.md`
32
+ - **docs.html & de/docs.html** – new “AI Reference” / “KI-Referenz” section with sidebar link
33
+ - **index.html & de/index.html** – SKILL.md added to project file list
34
+ - Version references updated to 1.3.5 across all files
21
35
 
22
36
  ---
23
37
 
@@ -207,9 +221,10 @@ during development. Version 1.3 is the first public open-source release.
207
221
 
208
222
  ---
209
223
 
224
+ [1.3.5]: https://github.com/JUNGHERZ/GlassKit/releases/tag/v1.3.5
210
225
  [1.3.4]: https://github.com/JUNGHERZ/GlassKit/releases/tag/v1.3.4
211
226
  [1.3.3]: https://github.com/JUNGHERZ/GlassKit/releases/tag/v1.3.3
212
227
  [1.3.2]: https://github.com/JUNGHERZ/GlassKit/releases/tag/v1.3.2
213
228
  [1.3.1]: https://github.com/JUNGHERZ/GlassKit/releases/tag/v1.3.1
214
229
  [1.3.0]: https://github.com/JUNGHERZ/GlassKit/releases/tag/v1.3.0
215
- [Unreleased]: https://github.com/JUNGHERZ/GlassKit/compare/v1.3.4...HEAD
230
+ [Unreleased]: https://github.com/JUNGHERZ/GlassKit/compare/v1.3.5...HEAD
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
1
  <p align="center">
2
- <img src="https://img.shields.io/badge/version-1.3.4-orange?style=flat-square" alt="Version">
2
+ <img src="https://img.shields.io/badge/version-1.3.5-orange?style=flat-square" alt="Version">
3
3
  <img src="https://img.shields.io/badge/CSS-only-blue?style=flat-square" alt="CSS only">
4
4
  <img src="https://img.shields.io/badge/components-22-green?style=flat-square" alt="Components">
5
5
  <img src="https://img.shields.io/badge/license-MIT-lightgrey?style=flat-square" alt="License">
6
- <a href="CHANGELOG.md"><img src="https://img.shields.io/badge/changelog-v1.3.4-f5a623?style=flat-square" alt="Changelog"></a>
6
+ <a href="CHANGELOG.md"><img src="https://img.shields.io/badge/changelog-v1.3.5-f5a623?style=flat-square" alt="Changelog"></a>
7
7
  <a href="https://www.npmjs.com/package/@jungherz-de/glasskit"><img src="https://img.shields.io/npm/v/@jungherz-de/glasskit?style=flat-square&color=cb3837&label=npm" alt="npm"></a>
8
8
  <a href="https://cdn.jsdelivr.net/npm/@jungherz-de/glasskit/"><img src="https://img.shields.io/badge/CDN-jsDelivr-blue?style=flat-square" alt="jsDelivr"></a>
9
9
  </p>
@@ -50,6 +50,7 @@ GlassKit is a complete **CSS component library** with glassmorphism aesthetics
50
50
  - 🧩 **Shadow DOM ready** – Constructable Stylesheet for Web Components included
51
51
  - 🪶 **Lightweight** – ~45 KB (uncompressed), no external dependencies
52
52
  - 🎯 **BEM-like naming convention** – `glass-*` prefix, no conflicts with existing CSS
53
+ - 🤖 **AI-ready** – ships with [`SKILL.md`](SKILL.md), a structured reference for LLMs & AI copilots
53
54
 
54
55
  ---
55
56
 
@@ -428,6 +429,7 @@ glasskit/
428
429
  ├── showcase.html # Interactive showcase of all components
429
430
  ├── docs.html # Full documentation
430
431
  ├── de/ # German translations (index, docs, showcase)
432
+ ├── SKILL.md # AI-optimized component reference (for LLMs & copilots)
431
433
  ├── LICENSE # MIT License
432
434
  └── README.md # This file
433
435
  ```
@@ -462,6 +464,27 @@ Useful links:
462
464
 
463
465
  ---
464
466
 
467
+ ## 🤖 AI / LLM Reference (`SKILL.md`)
468
+
469
+ GlassKit ships with an **AI-optimized component reference** in [`SKILL.md`](SKILL.md). This file is designed for LLMs, AI copilots, and code-generation tools to produce correct GlassKit markup without parsing `docs.html`.
470
+
471
+ ### What it provides
472
+
473
+ - **Copy-paste-ready HTML** for all 22 components with exact nesting rules
474
+ - **Complete design token tables** (colors, surfaces, blur, radii, spacing, shadows, typography)
475
+ - **State class reference** – which class goes where (`is-active`, `is-open`, `is-visible`, `:checked`)
476
+ - **6 composition patterns** – full page layouts (Login, Dashboard, Form, Modal, Settings, Progress)
477
+ - **Common mistakes & corrections** – prevents the most frequent AI-generated errors
478
+ - **Quick reference table** – all components with their modifiers at a glance
479
+
480
+ ### Usage with AI assistants
481
+
482
+ Attach or reference `SKILL.md` when asking an AI to generate GlassKit HTML. It provides the structured context needed for production-ready output – correct BEM hierarchy, proper modifier usage, and idiomatic component composition.
483
+
484
+ > **Tip:** While `docs.html` is built for humans browsing with live previews, `SKILL.md` is built for machines generating code. Both are kept in sync.
485
+
486
+ ---
487
+
465
488
  ## 🌐 Browser Compatibility
466
489
 
467
490
  GlassKit uses `backdrop-filter` for glass effects. Support: