astro-consent 1.0.1 → 1.0.4

package/README.md

@@ -1,6 +1,6 @@
-# astro-cookiebanner
+# astro-consent
 
-A **privacy‑first, zero‑dependency cookie consent banner** for Astro projects — built for speed, compliance, and full visual control.
+A **privacy-first, zero-dependency cookie consent banner** for Astro projects — built for speed, compliance, and full visual control.
 
 Designed and maintained by **Velohost**.
 
@@ -20,34 +20,46 @@ Designed and maintained by **Velohost**.
 
 ---
 
-## 📦 Installation
+## 📦 Installation (Required)
+
+This package uses **both an Astro integration and a CLI installer**.
+
+### 1️⃣ Install the package
 
 ```bash
-npm install astro-cookiebanner
+npm install astro-consent
 ```
 
-Then run the installer inside your Astro project:
+This step is **required** so Astro can import the integration at build time.
+
+### 2️⃣ Run the installer
 
 ```bash
-npx astro-cookiebanner
+npx astro-consent
 ```
 
-To remove everything:
+This will:
+
+- Inject the Astro integration into `astro.config.*`
+- Create `src/cookiebanner.css` (theme variables)
+- Enable the consent banner automatically
+
+### ❌ Uninstall
 
 ```bash
-npx astro-cookiebanner remove
+npx astro-consent remove
 ```
 
 ---
 
-## 🔧 Usage
+## 🔧 Astro Integration Usage
 
 ```ts
-import astroCookieBanner from "astro-cookiebanner";
+import astroConsent from "astro-consent";
 
 export default {
   integrations: [
-    astroCookieBanner({
+    astroConsent({
       siteName: "My Website",
       policyUrl: "/privacy",
       consent: {
@@ -73,16 +85,6 @@ window.cookieConsent.set({ essential: true, analytics: true });
 window.cookieConsent.reset();
 ```
 
-Example conditional loading:
-
-```js
-const consent = window.cookieConsent.get();
-
-if (consent?.categories?.analytics) {
-  // Load analytics script
-}
-```
-
 ---
 
 ## 🎨 Theming
@@ -112,17 +114,8 @@ Open‑source with **mandatory attribution**.
 
 Any public use, fork, or redistribution **must credit Velohost**.
 
-See `LICENSE.md` for full terms.
-
 ---
 
 ## 🏢 Velohost
 
-Built by **Velohost**  
-https://velohost.co.uk
-
----
-
-## 🤝 Contributions
-
-PRs welcome — attribution must be preserved.
+https://velohost.co.uk/

package/README.md.bak

@@ -0,0 +1,128 @@
+# astro-cookiebanner
+
+A **privacy‑first, zero‑dependency cookie consent banner** for Astro projects — built for speed, compliance, and full visual control.
+
+Designed and maintained by **Velohost**.
+
+---
+
+## ✨ Features
+
+- ✅ GDPR / UK GDPR friendly
+- 🍪 Essential, Analytics & Marketing categories
+- 🎛️ Manage preferences modal with toggle switches
+- ⚡ No external dependencies
+- 🎨 Fully themeable via CSS variables
+- 🧠 Frontend‑controlled script loading
+- 🧩 Astro Integration + CLI installer
+- 🔁 Easy uninstall via CLI
+- 🌍 Framework‑agnostic frontend API
+
+---
+
+## 📦 Installation
+
+```bash
+npm install astro-cookiebanner
+```
+
+Then run the installer inside your Astro project:
+
+```bash
+npx astro-cookiebanner
+```
+
+To remove everything:
+
+```bash
+npx astro-cookiebanner remove
+```
+
+---
+
+## 🔧 Usage
+
+```ts
+import astroCookieBanner from "astro-cookiebanner";
+
+export default {
+  integrations: [
+    astroCookieBanner({
+      siteName: "My Website",
+      policyUrl: "/privacy",
+      consent: {
+        days: 30,
+        storageKey: "astro-cookie-consent"
+      },
+      categories: {
+        analytics: false,
+        marketing: false
+      }
+    })
+  ]
+};
+```
+
+---
+
+## 🧠 Frontend API
+
+```js
+window.cookieConsent.get();
+window.cookieConsent.set({ essential: true, analytics: true });
+window.cookieConsent.reset();
+```
+
+Example conditional loading:
+
+```js
+const consent = window.cookieConsent.get();
+
+if (consent?.categories?.analytics) {
+  // Load analytics script
+}
+```
+
+---
+
+## 🎨 Theming
+
+All visuals are controlled via:
+
+```
+src/cookiebanner.css
+```
+
+This file is never overwritten.
+
+---
+
+## 🔐 Privacy
+
+- No cookies before consent
+- No tracking without permission
+- No external calls
+- Stored locally with TTL
+
+---
+
+## 🏷️ License & Attribution
+
+Open‑source with **mandatory attribution**.
+
+Any public use, fork, or redistribution **must credit Velohost**.
+
+See `LICENSE.md` for full terms.
+
+---
+
+## 🏢 Velohost
+
+Built by **Velohost**  
+https://velohost.co.uk
+
+---
+
+## 🤝 Contributions
+
+PRs welcome — attribution must be preserved.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-consent",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "A privacy-first, GDPR-compliant cookie consent banner for Astro with a built-in preferences modal, zero dependencies, and full theme control.",
   "type": "module",
   "author": {
@@ -21,7 +21,7 @@
     ".": "./dist/index.js"
   },
   "bin": {
-    "astro-cookiebanner": "dist/cli.cjs"
+    "astro-consent": "dist/cli.cjs"
   },
   "files": [
     "dist",