@finqu/cool 1.3.0 → 2.0.2

package/README.md

@@ -25,14 +25,14 @@ When you install `@finqu/cool`, you get the `dist/` folder:
 
 | File | Description |
 |------|-------------|
-| `dist/js/cool.bundle.js` | UMD bundle with all dependencies (jQuery, PerfectScrollbar) included |
+| `dist/js/cool.bundle.js` | UMD bundle — includes jQuery + PerfectScrollbar for legacy convenience |
 | `dist/js/cool.bundle.min.js` | Minified UMD bundle |
-| `dist/js/cool.esm.js` | ES module build (external jQuery) |
+| `dist/js/cool.esm.js` | ES module build (no dependencies bundled) |
 | `dist/js/cool.esm.min.js` | Minified ES module build |
-| `dist/js/cool.js` | UMD standalone build (external jQuery) |
+| `dist/js/cool.js` | UMD standalone build (no dependencies bundled) |
 | `dist/js/cool.min.js` | Minified UMD standalone |
 
-**Bundle vs Standalone:** The `.bundle.js` files include jQuery and PerfectScrollbar for legacy compatibility. The standalone `.js` and `.esm.js` files keep these as external dependencies.
+**Bundle vs Standalone:** The `.bundle.js` files include jQuery and PerfectScrollbar for legacy convenience. The standalone `.js` and `.esm.js` files do not include them — both are **optional** and can be provided externally if needed.
 
 ---
 
@@ -69,7 +69,7 @@ document.addEventListener('DOMContentLoaded', () => {
 });
 ```
 
-> The ESM build expects jQuery and PerfectScrollbar as external dependencies. The bundle build (`cool.bundle.js`) includes them automatically.
+> The ESM and standalone builds work without jQuery or PerfectScrollbar. Both are **optional** — add jQuery only if you need the legacy `$.data()` plugin wrapper, and PerfectScrollbar only if you want custom scrollbars (otherwise native scrolling is used). The bundle build (`cool.bundle.js`) includes both for convenience.
 
 ### Without a bundler (script tags)
 
@@ -666,10 +666,24 @@ Defined in `.browserslistrc`:
 Cool UI's JavaScript is written in native ECMAScript. jQuery is used only as a
 legacy compatibility layer for the plugin wrapper pattern.
 
-| Dependency | Purpose | Included in bundle | Required for standalone/ESM |
-|------------|---------|-------------------|-----------------------------|
-| [jQuery](https://jquery.com/) ^3.7.1 | Legacy plugin wrapper | ✅ `cool.bundle.js` | Must be provided externally |
-| [PerfectScrollbar](https://github.com/mdbootstrap/perfect-scrollbar) ^1.5.6 | Custom scrollbars | ✅ `cool.bundle.js` | Must be provided externally |
+| Dependency | Purpose | Included in bundle | Required? |
+|------------|---------|-------------------|----------|
+| [jQuery](https://jquery.com/) ^3.7.1 | Legacy `$.data()` plugin wrapper | ✅ `cool.bundle.js` | **Optional** — only needed for the legacy jQuery wrapper |
+| [PerfectScrollbar](https://github.com/mdbootstrap/perfect-scrollbar) ^1.5.6 | Custom scrollbars in sidebar/select | ✅ `cool.bundle.js` | **Optional** — falls back to native scrolling |
+
+---
+
+## Contributing
+
+We welcome contributions! Please read our [Contributing Guide](docs/contributing.md) to learn about:
+
+- Development workflow and setup
+- Coding standards and conventions
+- Building and testing the project
+- Submitting pull requests
+- Reporting bugs and requesting features
+
+For questions or discussions, please [open an issue](https://github.com/finqu/cool/issues) on GitHub.
 
 ---