@fiddle-digital/string-tune 0.0.64 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiddle-digital/string-tune",
-  "version": "0.0.64",
+  "version": "1.0.0",
   "description": "StringTune is a cutting-edge JavaScript library designed to deliver high-performance, modular web effects. Whether you're looking to add smooth parallax scrolling, dynamic cursor interactions, progress tracking, or autoplay videos, StringTune empowers developers with a powerful, attribute-driven approach. It simplifies the creation of visually captivating websites while remaining intuitive for both beginner and advanced developers.",
   "keywords": [
     "scroll",
@@ -44,6 +44,7 @@
       "default": "./dist/index.js"
     }
   },
+  
   "scripts": {
     "build": "tsup",
     "build:prod": "tsup --sourcemap false",

package/readme.md

@@ -1,9 +1,3 @@
-
-![Alpha](https://img.shields.io/badge/Status-Alpha-red)
-[![Alpha](https://img.shields.io/badge/gzip-4.1kB-brightgreen
-)](https://bundlephobia.com/package/@fiddle-digital/string-tune@0.0.1)
-  
-
 # Overview
 
 ## What is StringTune?
@@ -12,24 +6,24 @@
 
 ### Key Features
 
--   **Modular Architecture**: Use only the modules you need to keep your project lightweight and optimized.
--   **Attribute-Based Integration**: Configure effects directly in HTML with clear, descriptive attributes.
--   **Wide Range of Effects**:
-    -   Parallax scrolling
-    -   Magnetic cursor
-    -   Progress indicators
-    -   Split text animations
-    -   Autoplay videos
--   **Effortless Initialization**: Start everything with a few lines of JavaScript.
--   **Performance-Oriented**: Built for smooth performance even on complex pages.
+- **Modular Architecture**: Use only the modules you need to keep your project lightweight and optimized.
+- **Attribute-Based Integration**: Configure effects directly in HTML with clear, descriptive attributes.
+- **Wide Range of Effects**:
+  - Parallax scrolling
+  - Magnetic cursor
+  - Progress indicators
+  - Split text animations
+  - Autoplay videos
+- **Effortless Initialization**: Start everything with a few lines of JavaScript.
+- **Performance-Oriented**: Built for smooth performance even on complex pages.
 
 ### Who is StringTune for?
 
 StringTune is perfect for:
 
--   **Beginner Developers**: Simplify the process of adding advanced web effects without deep technical knowledge.
--   **Experienced Developers**: Leverage modularity and API options to create complex, custom effects.
--   **Designers**: Bring creative visions to life with minimal setup.
+- **Beginner Developers**: Simplify the process of adding advanced web effects without deep technical knowledge.
+- **Experienced Developers**: Leverage modularity and API options to create complex, custom effects.
+- **Designers**: Bring creative visions to life with minimal setup.
 
 # Introduction
 
@@ -46,9 +40,9 @@ In a world of constantly evolving web experiences, **StringTune** helps you stay
 
 ### Core Principles
 
--   **Declarative First**: Most configurations are handled via HTML attributes, reducing the need for verbose JavaScript.
--   **Customizable**: Provides an API for developers who need fine-grained control over effects.
--   **Performant**: Optimized to handle intensive animations without compromising user experience.
+- **Declarative First**: Most configurations are handled via HTML attributes, reducing the need for verbose JavaScript.
+- **Customizable**: Provides an API for developers who need fine-grained control over effects.
+- **Performant**: Optimized to handle intensive animations without compromising user experience.
 
 ### Example Use Case
 
@@ -71,16 +65,15 @@ const stringTune = StringTune.getInstance();
 stringTune.use(StringParallax);
 stringTune.use(StringMagnetic);
 stringTune.start(60); // Start with 60 FPS
-
 ```
 
 ⚠ Note: When using CDN, you must reference the full namespace:
+
 ```javascript
 const stringTune = StringTune.StringTune.getInstance(); // Full namespace for CDN users
 stringTune.use(StringTune.StringParallax);
 stringTune.use(StringTune.StringMagnetic);
 stringTune.start(60);
-
 ```
 
 And finally we make the elements work
@@ -94,15 +87,14 @@ And finally we make the elements work
     Hover over me!
   </div>
 </div>
-
 ```
 
 ### When to Use StringTune
 
--   To create visually appealing websites with minimal effort.
--   When you need customizable effects that are easy to integrate.
--   To enhance user engagement through interactive animations.
+- To create visually appealing websites with minimal effort.
+- When you need customizable effects that are easy to integrate.
+- To enhance user engagement through interactive animations.
 
-----------
+---
 
-Get started with **StringTune** today and elevate your web experiences to the next level.
+Get started with **StringTune** today and elevate your web experiences to the next level.