@myxo-victor/chexjs 6.0.0 → 6.0.1

package/ChexJs/README.md

@@ -1,17 +1,29 @@
-# Chex 6.0.0
+# ChexJs
 
-Chex is a lightweight JavaScript UI engine for fast, reactive, component-driven interfaces. It runs directly in the browser with no compiler or build step.
+[![npm version](https://app.aximon.ng/Chex/logo.png)](https://www.npmjs.com/package/@myxo-victor/chexjs)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](#license)
 
-## Quick start
+**ChexJs** is a lightweight, high-performance JavaScript UI engine for building reactive, component-driven interfaces. It runs directly in the browser with zero build steps, no compilers, and no `node_modules` overhead.
 
-Include the engine, then write components with the tag helpers you need:
+---
 
-```html
-<script src="./Chex.js"></script>
-<script src="./components/main.js"></script>
+## Installation
+
+Install via npm:
+
+```bash
+npm install @myxo-victor/chexjs
 ```
 
+---
+
+## Quick Start
+
+Import and write components using Chex's tag helpers:
+
 ```js
+import Chex from '@myxo-victor/chexjs';
+
 const { div, h1, button } = Chex;
 const app = document.getElementById('app');
 const count = Chex.signal(0);
@@ -24,13 +36,13 @@ const Counter = () => div({ class: 'counter' }, [
 Chex.render(app, Counter);
 ```
 
-## Fast element API
+---
 
-Chex tag helpers accept props when you have them, and accept children directly when you do not:
+## Fast Element API
 
-```js
-const { div, h1, button } = Chex;
+Chex tag helpers are flexible. You can provide props as the first argument, or omit them entirely to pass children directly:
 
+```js
 // With props
 div({ class: 'hero' }, [
   h1({}, 'Title'),
@@ -44,26 +56,25 @@ div([
 ]);
 ```
 
-You can also use `Chex.div(...)`, `Chex.h1(...)`, and any standard HTML tag directly.
+---
 
-## Core features
+## Core Features
 
-- Fast VNode rendering and DOM patching with `Chex.render(...)`
-- Concise tag helpers and custom-tag support
-- Signals and effects: `Chex.signal(...)`, `Chex.effect(...)`
-- Hash or history routing with `Chex.createRouter(...)`
-- Fetch and cached query helpers through `Chex.api`
-- Secure PHP database client through `Chex.db`
-- Notifications, service-worker registration, and animation helpers
-- Reusable UI components: Button, Input, AppBar, SideBar, BottomNav, and Card
+- **Reactive State** — Built-in signals and effects (`Chex.signal`, `Chex.effect`)
+- **VDOM Patching** — Efficient DOM updates via `Chex.render`
+- **Zero-Dependency Routing** — Hash- or history-based routing with `Chex.createRouter`
+- **Integrated Backend** — Built-in PHP database client (`Chex.db`) and API helpers
+- **Standalone Helpers** — Additional engines for modals, skeleton loaders, sliders (`orbit`), and scroll animations (`rinx`, `scrollEcho`)
 
-## Backend database engine
+---
 
-`Chex.php` is the optional secure PHP/PDO endpoint used by `Chex.db.connect(...)`.
+## Backend Database Engine
+
+The optional `Chex.php` provides a secure PDO bridge for your frontend:
 
 ```js
 const server = Chex.db.connect({
-  endpoint: '/Chex.php',
+  endpoint: '/path/to/Chex.php',
   apiKey: 'YOUR_SECURE_API_KEY',
   table: 'users'
 });
@@ -72,50 +83,24 @@ await server.create({ email: 'demo@example.com' });
 const users = await server.read({ select: ['id', 'email'], limit: 10 });
 ```
 
-Open `Chex.php` to set database credentials, allowed origins, allowed tables, and the API key. The client sends the key in the `X-Chex-Key` header.
-
-`Chex_notify.php` receives browser notification registrations. Pair it with `Chex.notification.ask('/Chex_notify.php')` when notifications are enabled.
-
-## Included libraries
-
-All libraries are standalone and dependency-free. Load them after `Chex.js` when needed.
+---
 
-| File | Global | Purpose |
-| --- | --- | --- |
-| `scrollEcho.js` | `ScrollEcho` | Scroll-triggered text and element reveals. |
-| `racket.js` | `racket` | Responsive multi-panel image carousel. |
-| `orbit.js` | `orbit` | Swipe-friendly banner and slider helper. |
-| `rinx.js` | `rinx` | Horizontal and vertical scroll-card layouts. |
-| `smooth.js` | `smooth` | Continuous ticker and infinite carousel. |
-| `modal.js` | `modal` | Self-styling, zero-dependency accessible modal engine. |
-| `skeleton.js` | `skeleton` | DOM-to-skeleton shimmer loader that reduces layout shift. |
+## Standalone Libraries
 
-Example:
-
-```html
-<script src="./Chex.js"></script>
-<script src="./libs/modal.js"></script>
-<script src="./libs/skeleton.js"></script>
-```
-
-## Project structure
-
-```text
-ChexJs/
-  Chex.js              Core engine
-  Chex.php             Optional PHP/PDO backend
-  Chex_notify.php      Notification registration endpoint
-  components/          Page components and views
-  libs/                Standalone visual and UI helpers
-  index.html           Welcome page launcher
-  index.css            Welcome page styles
-  sw.js                Service worker
-```
+All included UI libraries are dependency-free:
 
-## Documentation
+| Library | Global | Purpose |
+|---|---|---|
+| `scrollEcho.js` | `ScrollEcho` | Scroll-triggered reveals |
+| `racket.js` | `racket` | Image carousel |
+| `orbit.js` | `orbit` | Swipe-friendly sliders |
+| `rinx.js` | `rinx` | Scroll-card layouts |
+| `smooth.js` | `smooth` | Continuous tickers |
+| `modal.js` | `modal` | Accessible modal engine |
+| `skeleton.js` | `skeleton` | Shimmer loaders |
 
-Open `docs/index.html` through a local web server for the full API, component, backend, library, and example guides.
+---
 
 ## License
 
-MIT License. Copyright (c) 2026 Aximon. Created by Myxo Victor.
+MIT License. Copyright (c) 2026 Aximon. Created by **Myxo Victor**.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myxo-victor/chexjs",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "A zero-build UI framework with reactive signals, VDOM diffing, routing, state, and a built-in PHP backend bridge — just a script tag, no compiler.",
   "main": "Chex.js",
   "keywords": ["ui", "framework", "vdom", "signals", "Chex", "chexjs"],