@adityabheke/renderer-package 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,112 @@
+# 📦 @adityabheke/renderer-package
+
+A production-ready React page renderer that converts JSON schema into fully responsive UI using Tailwind CSS v4 and runtime CSS variables.
+
+Built for dynamic website/page builder systems.
+
+---
+
+## 🚀 Features
+
+* ⚡ Schema-driven rendering
+* 🎨 Tailwind CSS v4 (precompiled – no setup required in consumer app)
+* 📱 Fully responsive (container query variants supported)
+* 🎞 Built-in animation support (`tailwindcss-animate`)
+* 🧩 Plug-and-play integration
+* 📦 ESM + CJS support
+* 🧠 TypeScript definitions included
+* 🔒 No Tailwind configuration required in the user project
+
+---
+
+## 📥 Installation
+
+```bash
+npm install @adityabheke/renderer-package
+```
+
+---
+
+## ⚠️ Peer Dependencies
+
+Make sure your project has the following installed:
+
+```bash
+npm install react react-dom react-router-dom lucide-react
+```
+
+Required versions:
+
+* react >= 18
+* react-dom >= 18
+* react-router-dom >= 6
+* lucide-react >= 0.300.0
+
+---
+
+## 🛠 Usage
+
+### 1️⃣ Import Styles (Required Once)
+
+```tsx
+import "@adityabheke/renderer-package/styles.css";
+```
+
+### 2️⃣ Use the Renderer
+
+```tsx
+import { PageRenderer } from "@adityabheke/renderer-package";
+
+function App() {
+  return (
+    <BrowserRouter>
+      <Routes>
+        <Route path='*' element={<PageRenderer url={CLIENT_URL} />} />
+      </Routes>
+    </BrowserRouter>
+  )
+}
+```
+    CLIENT_URL = will be provided by admin
+---
+
+## 🧠 How It Works
+
+* Parses JSON schema
+* Resolves components using internal `ComponentRegistry`
+* Applies dynamic CSS variables
+* Uses precompiled Tailwind CSS
+* Supports responsive container-based variants
+* Supports animation classes like:
+
+  * `animate-in`
+  * `slide-in-from-*`
+
+---
+
+## 📁 Package Output Structure
+
+```
+dist/
+  index.js
+  index.cjs
+  index.d.ts
+  styles.css
+```
+
+---
+
+## 🧪 Tested With
+
+* Vite
+* React 18+
+
+---
+
+## 📌 Versioning
+
+This package follows semantic versioning:
+
+* 1.x → Stable renderer core
+* 2.x → Breaking schema or architecture changes
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adityabheke/renderer-package",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Production-ready React page renderer",
   "type": "module",
   "license": "MIT",