@privacykit/web 0.1.11 → 1.0.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import "./styles.css";
+import "../styles.css";
 export type InitPrivacyKitOptions = {
     version?: string;
     cdnBaseUrl?: string;

package/dist/index.js

@@ -1,5 +1,4 @@
-/// <reference path="../privacykit.d.ts" />
-import "./styles.css";
+import "../styles.css";
 const DEFAULT_CDN_BASE_URL = "https://cdn.privacykit.eu";
 const DEFAULT_VERSION = "v1";
 function addScript(src, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@privacykit/web",
-  "version": "0.1.11",
+  "version": "1.0.0",
   "description": "Developer-friendly GDPR consent management with real enforcement.",
   "main": "./dist/index.js",
   "types": "./index.d.ts",

package/readme.md

@@ -1,5 +1,66 @@
 # PrivacyKit
 
-Developer-friendly GDPR consent management with real enforcement.
+Consent management, enforcement, and runtime compliance validation in one platform.
 
-https://www.privacykit.eu
+[![npm](https://img.shields.io/npm/v/@privacykit/web)](https://www.npmjs.com/package/@privacykit/web)
+[![license](https://img.shields.io/npm/l/@privacykit/web)](https://www.privacykit.eu)
+
+**[Quick Start](https://www.privacykit.eu/en/quick-start) · [Web Components](https://www.privacykit.eu/en/web-components) · [API Reference](https://www.privacykit.eu/en/api-reference) · [privacykit.eu](https://www.privacykit.eu)**
+
+---
+
+## Why PrivacyKit
+
+Most consent tools show a dialog — PrivacyKit also enforces it. Third-party scripts and embedded content are blocked until the user grants consent, and a built-in Compliance Monitor continuously validates that nothing slips through after a website change.
+
+| | PrivacyKit |
+|---|---|
+| Works with any frontend | ✅ Lightweight web components — no framework lock-in |
+| Control when third-party code executes | ✅ Consent Guards block scripts and embeds until consent |
+| Continuous compliance monitoring & validation | ✅ Runtime monitor, not a periodic scanner |
+| Customizable | ✅ Design tokens, themes, slots, layouts |
+
+---
+
+## Installation
+
+```bash
+npm install @privacykit/web
+```
+
+The package includes web components, the JavaScript API, TypeScript definitions, and anti-flicker styles.
+
+Alternatively, use the CDN:
+
+```html
+<script type="module" src="https://cdn.privacykit.eu/v1/privacykit.esm.js"></script>
+<script nomodule src="https://cdn.privacykit.eu/v1/privacykit.js"></script>
+```
+
+---
+
+## Quick Start
+
+Get PrivacyKit running in minutes — add the consent dialog to your site via npm or CDN, with no account or registration required to start. A 10-day trial is included.
+
+→ [privacykit.eu/en/quick-start](https://www.privacykit.eu/en/quick-start)
+
+---
+
+## Web Components
+
+PrivacyKit ships four web components: `<consent-dialog>`, `<consent-guard>`, `<consent-missing>`, and `<compliance-monitor>`. They work with any frontend framework or plain HTML.
+
+→ [privacykit.eu/en/web-components](https://www.privacykit.eu/en/web-components)
+
+---
+
+## JavaScript API
+
+All methods are available on `window.PrivacyKit` — read consent state, subscribe to changes, open dialogs, and toggle the Compliance Monitor from application code.
+
+→ [privacykit.eu/en/api-reference](https://www.privacykit.eu/en/api-reference)
+
+---
+
+MIT License © PrivacyKit · [support@privacykit.eu](mailto:support@privacykit.eu)