@twobirds/microcomponents 0.0.72 → 0.0.73

package/README.md

@@ -4,19 +4,27 @@
 
 **This code aims at improving Javascript modularity and encapsulation**.
 
-Using micro components enforces **DRY, KISS and SOLID** principles in Javascript programming.
+Micro Components are built on **OOP** for structure, so you should embrace **DRY, KISS and SOLID** principles.
 
-Also you should embrace **DIY** (Do It Yourself) **over Toolchains** as much as possible.
+Its basic principle is **composition over inheritance**. It is strongly advised you do not extend your own classes, as it is not needed.
+
+Also it helps to embrace **DIY** (Do It Yourself) **over Toolchains**, but this is up to your personal preference.
+
+That said, feel free to code **functional**, or *4.5 dimensional ;-)* or any other approach I may have forgot or don't know. This system doesn't cage you. 
+
+You can use **Vanilla JS or Typescript** or both in your project. For example you could use plain JS for rapid prototyping functionalities, then convert to TS for production.
 
 ## Think **Building Blocks**
 
 In general this is a **HTML / Web Standards first** system. There is almost no abstraction, especially not for templating, except state binding to the DOM via simple placeholders.
 
-When coding with this system, you create classes that extend either the **[MC](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/MC.md?ref_type=heads#mc-class-extends-mcbase)** or **[DC](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/MC.md?ref_type=heads#dc-class-extends-mcbase)** superclasses provided here. These classes provide the structure you need to build your wonderland. You can attach instances of your custom code to any HTMLElement, and there can be as many as you want connected to a single HTML tag.
+When coding with this system, you create classes that extend either the **[MC](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/MC.md?ref_type=heads#mc-class-extends-mcbase)** or **[DC](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/MC.md?ref_type=heads#dc-class-extends-mcbase)** superclasses provided here. These classes provide the structure you need to build your wonderland. 
 
-In an almost literal sense they work like childrens building blocks, where a chest full of unassuming parts lets you compose whatever functionality lies in your imagination.
+You **attach instances of your classes to any HTMLElement**, and there can be as many as you want connected to a single HTML tag. In an almost literal sense they work like childrens building blocks, where a chest full of unassuming parts lets you compose whatever functionality lies in your imagination.
 
-Also you can easily define native JS custom elements. Since these are just another instance of a DC internally, you can enhance them even at runtime, as they are displayed in the browser.
+Also you can easily **define JS custom elements**. Since these are just another instance of a DC internally, you can enhance them even at runtime, as they are displayed in the browser.
+
+## Principles
 
 This systems **modular** approach gives you full control over your software, without the need to rely on other frameworks. 
 
@@ -24,20 +32,22 @@ On the other hand, its **minimalistic** stance enables you to use the resulting
 
 ## Status
 
-**WIP**. Should be done soon. In [manual testing](https://twobirds.gitlab.io/microcomponents/test/test.html), also working a lot on the documentation.
+In [manual testing](https://twobirds.gitlab.io/microcomponents/test/test.html), also working a lot on the documentation.
 
 ## General
 
-- **This is a low-level OOP approach to Javascript programming.** It aims at proving that strict OOP is a valid alternative to other frameworks functional approaches.
-- You can use it **Vanilla JS or Typescript**.
-
-This repository exports 5 independent functionalities:
+This repository exports 4 independent functionalities:
 
 1. **[Micro Components](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/MC.md?ref_type=heads)** contains the **MC** and **DC** classes you can use as super classes.
-2. **[Elements](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/elements.md?ref_type=heads)** lets you define and use your own native web components. Uses (1). [Example Code](https://gitlab.com/twoBirds/microcomponents/-/blob/main/public/test/test.ts?ref_type=heads), use debugger console to [see it at work here](https://twobirds.gitlab.io/microcomponents/test/test.html).
-3. **[Observables](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/observables.md?ref_type=heads)** add **observability** and **run time type safety** to object properties. Also they provide **1-way binding** to placeholders in your template HTML. [Example Code](https://gitlab.com/twoBirds/microcomponents/-/blob/main/public/test/test.ts?ref_type=heads), use debugger console to [see it at work here](https://twobirds.gitlab.io/microcomponents/test/test.html).
-4. **[Formvalues](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/formvalues.md?ref_type=heads)** gives you **2-way binding** between a HTML form and an observable object. Uses (3). [Example Code](https://gitlab.com/twoBirds/microcomponents/-/blob/main/src/test/test/testform.ts?ref_type=heads), use debugger console to [see it at work here](https://twobirds.gitlab.io/microcomponents/test/test.html).
-5. (wip) **Selectors** provide chainable jQuery like selectors for both the DOM and micro components.
+2. **[Elements](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/elements.md?ref_type=heads)** lets you define and use your own native web components. Uses (1). 
+  - [Basic Usage](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/elements.md?ref_type=heads#create-a-custom-element). 
+  - [Live Example](https://twobirds.gitlab.io/microcomponents/test/test.html)
+3. **[Observables](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/observables.md?ref_type=heads)** add **observability** and **run time type safety** to object properties. Also they provide **1-way binding** to placeholders in your template HTML. 
+  - [Basic Usage](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/observables.md?ref_type=heads#example)
+  - [Live Example](https://twobirds.gitlab.io/microcomponents/test/test.html)
+4. **[Formvalues](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/formvalues.md?ref_type=heads)** gives you **2-way binding** between a HTML form and an observable object. Uses (3). 
+  - [Example Code](https://gitlab.com/twoBirds/microcomponents/-/blob/main/src/test/test/testform.ts?ref_type=heads)
+  - [Live Example](https://twobirds.gitlab.io/microcomponents/test/test.html)
 
 Also there is a bundle file that contains all of the above.
 

package/assets/documentation/MC.md

@@ -1,6 +1,6 @@
 ![logo](./MicroComponents.svg)
 
-# Micro Component Documentation
+# Micro Components
 
 This document details a lightweight JavaScript framework for creating and managing "microcomponents" (MCs) associated with DOM elements or other microcomponents. It allows you to define reusable components and attach them to build complex functionalities.
 

package/assets/documentation/MicroComponents.svg

@@ -0,0 +1,15 @@
+<svg width="200" height="200" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg">
+ <!-- Created with SVG-edit - http://svg-edit.googlecode.com/ -->
+ <title>test</title>
+ <rect fill="transparent" x="0" y="0" width="200" height="200" fill-opacity="1"/>
+ <g style="fill:transparent">
+  <title>first bird</title>
+  <path fill="#18829c" d="
+    m15,160
+    a30,75 45 1 0 160,-150
+    a20,50 225 1 1 -110,100
+    a12,25 45 1 1 60,-50
+    a20,50 225 1 0 -110,100
+    " />
+ </g>
+</svg>

package/assets/documentation/elements.md

@@ -21,10 +21,10 @@ Before:
 ```
 
 ```javascript
+// customElementRegistry.define() wrapper
 defineCE(
-	// equivalent to and internally using customElementRegistry.define()
-	"my-tag",
-	class extends DC {
+	"my-tag", // tag name
+	class MyTag extends DC { // definition class
 
 		constructor(target, data = {} ) {
 			super(target);
@@ -54,7 +54,7 @@ After:
 </body>
 ```
 
-### **Hints**
+**Hints**
 - Your code extends the **[DC](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/MicroComponents.md?ref_type=heads#dc-class-extends-mcbase)** superclass. This superclass provides methods to traverse the DOM and select other micro components contained in HTML elements.
 - it is essential to understand that your web component code is only one of the numerous micro components that can reside inside `<my-tag>`
 - After you created a custom element, the custom element will contain a **property `<my-tag>._mc`** which contains your class instance.
@@ -62,10 +62,10 @@ After:
 - Note that you can hand over data natively via parameters, when handling custom elements in above way.
 - The native way of usage, simply adding the tag to the template, is still possible. You have to use attributes then to hand in data.
 
-
 ## Web Component Lifecycle Events
 
 ```javascript
+// customElementRegistry.define() wrapper
 defineCE(
 	"my-tag",
 	class MyTag extends DC {
@@ -98,12 +98,14 @@ defineCE(
 	['my-attribute'] // DOM node attributes to observe
 );
 
-let MyTag = getCE("my-tag"),
-	myTag = new MyTag();
+let MyTag = getCE("my-tag"), // customElemtentRegistry.get("my-tag")
+	myTag = new MyTag(); // programmatically create a custom element instance
 
 document.body.append( myTag );
 ```
 
+## Composition with Micro Components
+
 You can use your Web Component constructor to add other modules to the `<my-tag>` DOM node:
 
 ```javascript
@@ -142,12 +144,12 @@ let MyTag = getCE("my-tag");
 document.body.append( new MyTag() );
 ```
 
-### **Hints**
+**Hints**
 - You can add as many other micro components to the DOM node as you like.
 - The native web component lifecycle events will be triggered on **all** micro components.
 - The event parameter handed over is an internal event instance, that contains the original native event in its `data` property.
 
-## Native Event Handlers
+## Native HTMLElement Event Handlers
 
 Native event handlers will be auto-attached, when the method name follows one of these two schemes:
 
@@ -178,11 +180,11 @@ let MyTag = getCE("my-tag");
 document.body.append( new MyTag() );
 ```
 
-### **Hints**
+**Hints**
 - The native web component lifecycle events will be triggered on **all** micro components contained in the custom element, provided the MC contains a matching named handler.
-- The event parameter handed over is an internal event instance, that contains the original native event in its .data property.
+- The event parameter handed over is an internal event instance, that contains the original native event in its `data` property.
 
-## Lifecycle Event Handlers
+# Lifecycle Event Handlers
 
 Currently there is only one lifecycle event handler: the **oneInit(){ ... }** method you provide with your class.
 
@@ -212,11 +214,11 @@ let MyTag = getCE("my-tag");
 document.body.append( new MyTag() );
 ```
 
-### **Hints**
+**Hints**
 - The native web component lifecycle events will be triggered on **all** micro components contained in the custom element, provided the specific micro component contains a matching named handler.
 - The event parameter handed over is an internal event instance that contains no data.
 
-## Custom Events
+# Custom Events
 
 ```javascript
 defineCE(
@@ -274,5 +276,5 @@ sendSpecialEvent(){
 }
 ```
 
-### **Hints**
-- The event parameter handed over is an internal event instance, that contains the payload in its .data property.
+**Hints**
+- The event parameter handed over is an internal event instance, that contains the payload in its `data` property.

package/assets/documentation/formvalues.md

@@ -1,26 +1,10 @@
-# Form Values Module Documentation
+![logo](./MicroComponents.svg)
 
-This module provides a way to bind form input elements (text, radio, checkbox, select, textarea) to a JavaScript object, enabling two-way data binding and change observation.
-
-## Key Components
-
-### InputBase (Abstract Class)
-- Base class for all input handlers
-- Defines `val` getter/setter interface
-
-### Input Handlers
-- **RadioHandler**: Manages radio button groups
-- **CheckboxHandler**: Handles checkbox state
-- **InputHandler**: For standard text inputs
-- **SelectHandler**: Manages select dropdowns (single/multi-select)
-- **TextAreaHandler**: For textarea elements
+# Form Values
 
-### getInputHandlers
-- Scans DOM for form elements
-- Returns object with name-to-handler mappings
-- Automatically creates appropriate handler type
+This module provides a way to bind form input elements (text, radio, checkbox, select, textarea) to a JavaScript object, enabling two-way data binding and change observation.
 
-### formValues Function
+## formValues Function
 Binds form elements to a target object:
 ```ts
 formValues(targetObject: LooseObject, propertyName: string, dom: HTMLElement | ShadowRoot)
@@ -31,16 +15,11 @@ Example code in constructor
     constructor(target: HTMLElement) {
         super(target);
 
-        const that = this;
-
-        delete that._mc; // not needed
-
         let shadow = (that as DC).target.attachShadow({ mode: 'open' });
-        shadow.innerHTML = `<style>${that.css}</style>${that.template}`;
+        shadow.innerHTML = `<style>${this.css}</style>${this.template}`;
 
         formValues(that, 'data', shadow); // create this.data formdata observable
 
-        (that.data as Observable).bind(shadow); // 1 way bind formdata to the form DOM
     }
 ```
 Full example [here](https://gitlab.com/twoBirds/microcomponents/-/blob/main/src/test/test/testform.ts?ref_type=heads).

package/assets/documentation/observables.md

@@ -1,6 +1,6 @@
 ![logo](./MicroComponents.svg)
 
-# Observables Documentation
+# Observables
 
 This module provides utilities for observing and binding data to DOM elements using placeholders. It supports reactive updates when data changes.
 
@@ -9,7 +9,7 @@ This module provides utilities for observing and binding data to DOM elements us
 - [Overview](#overview)
 - [Functions](#functions)
 - [Types](#types)
-- [Example Usage](#example-usage)
+- [Example](#example)
 
 ---
 
@@ -32,7 +32,7 @@ Registers a distinct property or all object properties as an observable, making
 Those properties are dual use: 
 
 - **Direct Assign Native Values**:  
-  - Directly assign native values to the property, and the observable will be notified of the change.
+  - Directly assign native values to the property, and the observable will be notified of the change and its callbacks will be run.
 
 - **Use as an Instance of Observable**
   - Use the property as an instance of the `Observable` class. This allows you to attach callbacks and react to changes. You can bind the property to DOM elements.
@@ -41,7 +41,7 @@ Those properties are dual use:
 
 ### `Observable`
 
-**Definition**  
+**Type**  
 ```typescript
 export type Observable = {
   observe: (cb: Callback) => void; // attach a callback to be notified of changes
@@ -59,47 +59,41 @@ export type Observable = {
   - Enables / Disables notifications.
   - By default, notifications are enabled.
   - If `enable` is `false`, notifications are disabled. You need to explicitly call `notify(true)` to re-enable notifications.
-  - Triggers all registered callbacks with the current data.
+  - Otherwise calls all registered callbacks with the current data.
 
 - `bind(target: HTMLElement | DocumentFragment | ShadowRoot)`  
   Binds the observable to a DOM element, replacing placeholders with data values.
 
 
-## Example Usage
+## Example
 
-```typescript
-import { observe } from './src/observables';
+HTML:
+```html
+<div id="user-card">
+  <p>Hello, {name}</p>
+  <p>Age: {age}</p>
+</div>
+```
+
+JavaScript:
+```javascript
+import { observe } from './observables.js';
 
 const data = {
   name: 'John',
   age: 30,
 };
 
-observe(data);
+observe(data); // all properties of the data object will be observed.
 
 const element = document.getElementById('user-card');
 data.bind(element);
 ```
 
-In HTML:
-```html
-<div id="user-card">
-  <p>Hello, {name}</p>
-  <p>Age: {age}</p>
-</div>
-```
-
 When `data.name` or `data.age` changes, the DOM updates automatically.
 
 ---
 
-## Dependencies
-
-- `helpers.js` - Provides utilities like `deepEqual`, `debounce`, `flattenObject`, etc.
-- `MC.js` - Contains `DC`, `HTMLMcElement`, and `McEvent` for DOM manipulation and event handling.
-
----
-
 ## Notes
 
 - Only objects can be bound to the DOM.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twobirds/microcomponents",
-	"version": "0.0.72",
+	"version": "0.0.73",
 	"description": "Micro Components Organization Class",
 	"main": "./dist/microcomponents.ts",
 	"types": "./dist/microcomponents.d.ts",

package/public/documentation/MC.md

@@ -1,6 +1,6 @@
 ![logo](./MicroComponents.svg)
 
-# Micro Component Documentation
+# Micro Components
 
 This document details a lightweight JavaScript framework for creating and managing "microcomponents" (MCs) associated with DOM elements or other microcomponents. It allows you to define reusable components and attach them to build complex functionalities.
 

package/public/documentation/MicroComponents.svg

@@ -0,0 +1,15 @@
+<svg width="200" height="200" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg">
+ <!-- Created with SVG-edit - http://svg-edit.googlecode.com/ -->
+ <title>test</title>
+ <rect fill="transparent" x="0" y="0" width="200" height="200" fill-opacity="1"/>
+ <g style="fill:transparent">
+  <title>first bird</title>
+  <path fill="#18829c" d="
+    m15,160
+    a30,75 45 1 0 160,-150
+    a20,50 225 1 1 -110,100
+    a12,25 45 1 1 60,-50
+    a20,50 225 1 0 -110,100
+    " />
+ </g>
+</svg>

package/public/documentation/elements.md

@@ -21,10 +21,10 @@ Before:
 ```
 
 ```javascript
+// customElementRegistry.define() wrapper
 defineCE(
-	// equivalent to and internally using customElementRegistry.define()
-	"my-tag",
-	class extends DC {
+	"my-tag", // tag name
+	class MyTag extends DC { // definition class
 
 		constructor(target, data = {} ) {
 			super(target);
@@ -54,7 +54,7 @@ After:
 </body>
 ```
 
-### **Hints**
+**Hints**
 - Your code extends the **[DC](https://gitlab.com/twoBirds/microcomponents/-/blob/main/assets/documentation/MicroComponents.md?ref_type=heads#dc-class-extends-mcbase)** superclass. This superclass provides methods to traverse the DOM and select other micro components contained in HTML elements.
 - it is essential to understand that your web component code is only one of the numerous micro components that can reside inside `<my-tag>`
 - After you created a custom element, the custom element will contain a **property `<my-tag>._mc`** which contains your class instance.
@@ -62,10 +62,10 @@ After:
 - Note that you can hand over data natively via parameters, when handling custom elements in above way.
 - The native way of usage, simply adding the tag to the template, is still possible. You have to use attributes then to hand in data.
 
-
 ## Web Component Lifecycle Events
 
 ```javascript
+// customElementRegistry.define() wrapper
 defineCE(
 	"my-tag",
 	class MyTag extends DC {
@@ -98,12 +98,14 @@ defineCE(
 	['my-attribute'] // DOM node attributes to observe
 );
 
-let MyTag = getCE("my-tag"),
-	myTag = new MyTag();
+let MyTag = getCE("my-tag"), // customElemtentRegistry.get("my-tag")
+	myTag = new MyTag(); // programmatically create a custom element instance
 
 document.body.append( myTag );
 ```
 
+## Composition with Micro Components
+
 You can use your Web Component constructor to add other modules to the `<my-tag>` DOM node:
 
 ```javascript
@@ -142,12 +144,12 @@ let MyTag = getCE("my-tag");
 document.body.append( new MyTag() );
 ```
 
-### **Hints**
+**Hints**
 - You can add as many other micro components to the DOM node as you like.
 - The native web component lifecycle events will be triggered on **all** micro components.
 - The event parameter handed over is an internal event instance, that contains the original native event in its `data` property.
 
-## Native Event Handlers
+## Native HTMLElement Event Handlers
 
 Native event handlers will be auto-attached, when the method name follows one of these two schemes:
 
@@ -178,11 +180,11 @@ let MyTag = getCE("my-tag");
 document.body.append( new MyTag() );
 ```
 
-### **Hints**
+**Hints**
 - The native web component lifecycle events will be triggered on **all** micro components contained in the custom element, provided the MC contains a matching named handler.
-- The event parameter handed over is an internal event instance, that contains the original native event in its .data property.
+- The event parameter handed over is an internal event instance, that contains the original native event in its `data` property.
 
-## Lifecycle Event Handlers
+# Lifecycle Event Handlers
 
 Currently there is only one lifecycle event handler: the **oneInit(){ ... }** method you provide with your class.
 
@@ -212,11 +214,11 @@ let MyTag = getCE("my-tag");
 document.body.append( new MyTag() );
 ```
 
-### **Hints**
+**Hints**
 - The native web component lifecycle events will be triggered on **all** micro components contained in the custom element, provided the specific micro component contains a matching named handler.
 - The event parameter handed over is an internal event instance that contains no data.
 
-## Custom Events
+# Custom Events
 
 ```javascript
 defineCE(
@@ -274,5 +276,5 @@ sendSpecialEvent(){
 }
 ```
 
-### **Hints**
-- The event parameter handed over is an internal event instance, that contains the payload in its .data property.
+**Hints**
+- The event parameter handed over is an internal event instance, that contains the payload in its `data` property.

package/public/documentation/formvalues.md

@@ -1,26 +1,10 @@
-# Form Values Module Documentation
+![logo](./MicroComponents.svg)
 
-This module provides a way to bind form input elements (text, radio, checkbox, select, textarea) to a JavaScript object, enabling two-way data binding and change observation.
-
-## Key Components
-
-### InputBase (Abstract Class)
-- Base class for all input handlers
-- Defines `val` getter/setter interface
-
-### Input Handlers
-- **RadioHandler**: Manages radio button groups
-- **CheckboxHandler**: Handles checkbox state
-- **InputHandler**: For standard text inputs
-- **SelectHandler**: Manages select dropdowns (single/multi-select)
-- **TextAreaHandler**: For textarea elements
+# Form Values
 
-### getInputHandlers
-- Scans DOM for form elements
-- Returns object with name-to-handler mappings
-- Automatically creates appropriate handler type
+This module provides a way to bind form input elements (text, radio, checkbox, select, textarea) to a JavaScript object, enabling two-way data binding and change observation.
 
-### formValues Function
+## formValues Function
 Binds form elements to a target object:
 ```ts
 formValues(targetObject: LooseObject, propertyName: string, dom: HTMLElement | ShadowRoot)
@@ -31,16 +15,11 @@ Example code in constructor
     constructor(target: HTMLElement) {
         super(target);
 
-        const that = this;
-
-        delete that._mc; // not needed
-
         let shadow = (that as DC).target.attachShadow({ mode: 'open' });
-        shadow.innerHTML = `<style>${that.css}</style>${that.template}`;
+        shadow.innerHTML = `<style>${this.css}</style>${this.template}`;
 
         formValues(that, 'data', shadow); // create this.data formdata observable
 
-        (that.data as Observable).bind(shadow); // 1 way bind formdata to the form DOM
     }
 ```
 Full example [here](https://gitlab.com/twoBirds/microcomponents/-/blob/main/src/test/test/testform.ts?ref_type=heads).

package/public/documentation/observables.md

@@ -1,6 +1,6 @@
 ![logo](./MicroComponents.svg)
 
-# Observables Documentation
+# Observables
 
 This module provides utilities for observing and binding data to DOM elements using placeholders. It supports reactive updates when data changes.
 
@@ -9,7 +9,7 @@ This module provides utilities for observing and binding data to DOM elements us
 - [Overview](#overview)
 - [Functions](#functions)
 - [Types](#types)
-- [Example Usage](#example-usage)
+- [Example](#example)
 
 ---
 
@@ -32,7 +32,7 @@ Registers a distinct property or all object properties as an observable, making
 Those properties are dual use: 
 
 - **Direct Assign Native Values**:  
-  - Directly assign native values to the property, and the observable will be notified of the change.
+  - Directly assign native values to the property, and the observable will be notified of the change and its callbacks will be run.
 
 - **Use as an Instance of Observable**
   - Use the property as an instance of the `Observable` class. This allows you to attach callbacks and react to changes. You can bind the property to DOM elements.
@@ -41,7 +41,7 @@ Those properties are dual use:
 
 ### `Observable`
 
-**Definition**  
+**Type**  
 ```typescript
 export type Observable = {
   observe: (cb: Callback) => void; // attach a callback to be notified of changes
@@ -59,47 +59,41 @@ export type Observable = {
   - Enables / Disables notifications.
   - By default, notifications are enabled.
   - If `enable` is `false`, notifications are disabled. You need to explicitly call `notify(true)` to re-enable notifications.
-  - Triggers all registered callbacks with the current data.
+  - Otherwise calls all registered callbacks with the current data.
 
 - `bind(target: HTMLElement | DocumentFragment | ShadowRoot)`  
   Binds the observable to a DOM element, replacing placeholders with data values.
 
 
-## Example Usage
+## Example
 
-```typescript
-import { observe } from './src/observables';
+HTML:
+```html
+<div id="user-card">
+  <p>Hello, {name}</p>
+  <p>Age: {age}</p>
+</div>
+```
+
+JavaScript:
+```javascript
+import { observe } from './observables.js';
 
 const data = {
   name: 'John',
   age: 30,
 };
 
-observe(data);
+observe(data); // all properties of the data object will be observed.
 
 const element = document.getElementById('user-card');
 data.bind(element);
 ```
 
-In HTML:
-```html
-<div id="user-card">
-  <p>Hello, {name}</p>
-  <p>Age: {age}</p>
-</div>
-```
-
 When `data.name` or `data.age` changes, the DOM updates automatically.
 
 ---
 
-## Dependencies
-
-- `helpers.js` - Provides utilities like `deepEqual`, `debounce`, `flattenObject`, etc.
-- `MC.js` - Contains `DC`, `HTMLMcElement`, and `McEvent` for DOM manipulation and event handling.
-
----
-
 ## Notes
 
 - Only objects can be bound to the DOM.