@alltuner/vibetuner 2.8.3 → 2.9.1

package/README.md

@@ -1,44 +1,149 @@
 # @alltuner/vibetuner
 
-Blessed JavaScript/frontend build dependencies for Vibetuner projects.
+**Blessed JavaScript/frontend build dependencies for Vibetuner projects**
 
-This package bundles all the essential frontend build tools and libraries needed for Vibetuner-based web applications.
+This package bundles all the essential frontend build tools and libraries needed for Vibetuner-based web applications. It provides a curated, version-locked set of dependencies for building modern, reactive web interfaces.
 
-## Included Dependencies
+## What is Vibetuner?
+
+Vibetuner is a production-ready scaffolding tool for FastAPI + MongoDB + HTMX web applications. This package (`@alltuner/vibetuner`) is the JavaScript component that provides:
+
+- **Tailwind CSS 4**: Utility-first CSS framework
+- **DaisyUI**: Beautiful component library for Tailwind
+- **HTMX 2**: Dynamic HTML without complex JavaScript
+- **Build tools**: CLI tools for asset compilation
 
-- **Tailwind CSS** (v4.1.16) - Utility-first CSS framework
-- **@tailwindcss/cli** - Tailwind CLI tool
-- **@tailwindcss/typography** - Beautiful typographic defaults
-- **DaisyUI** (v5.4.2) - Tailwind CSS component library
-- **HTMX** (v2.0.7) - High-power tools for HTML
-- **htmx-ext-preload** - HTMX preload extension
-- **htmx-ext-sse** - HTMX server-sent events extension
-- **concurrently** - Run multiple commands concurrently
+**This package is designed to be used within projects generated by the Vibetuner scaffolding tool.** It ensures consistent frontend tooling across all Vibetuner projects.
 
 ## Installation
 
 ```bash
+# In a Vibetuner-generated project (automatic)
+bun install
+
+# Add to an existing project
 bun add @alltuner/vibetuner
 # or
 npm install @alltuner/vibetuner
 ```
 
-## Usage
+## Quick Start
+
+The recommended way to use Vibetuner is via the scaffolding tool:
+
+```bash
+# Create a new project with all frontend tools configured
+uvx vibetuner scaffold new my-project
+cd my-project
+bun dev  # Start frontend asset building with hot reload
+```
+
+## Included Dependencies
+
+### Core Frontend Libraries
+- **Tailwind CSS** (4.1+): Modern utility-first CSS framework
+- **@tailwindcss/cli**: Command-line tool for Tailwind
+- **@tailwindcss/typography**: Beautiful typographic defaults
+- **DaisyUI** (5.4+): Tailwind CSS component library
+
+### Interactivity
+- **HTMX** (2.0+): High-power tools for HTML
+- **htmx-ext-preload**: Preload extension for faster navigation
+- **htmx-ext-sse**: Server-sent events extension for real-time updates
+
+### Build Tools
+- **concurrently**: Run multiple dev servers simultaneously
+
+## Usage in Generated Projects
 
-This package is typically used as a devDependency in Vibetuner projects to ensure consistent frontend tooling.
+In a Vibetuner-generated project, the package is automatically configured:
 
 ```json
 {
-  "devDependencies": {
-    "@alltuner/vibetuner": "^1.0.0"
+  "dependencies": {
+    "@alltuner/vibetuner": "^2.8.0"
+  },
+  "scripts": {
+    "dev": "concurrently \"bun:watch:*\"",
+    "watch:css": "tailwindcss ...",
+    "watch:js": "esbuild ..."
   }
 }
 ```
 
+The frontend asset pipeline is preconfigured for:
+- Tailwind CSS compilation with DaisyUI
+- HTMX integration
+- Hot reload during development
+- Production builds with minification
+
+## Frontend Stack
+
+### HTMX-First Approach
+
+Vibetuner uses HTMX for dynamic, reactive interfaces without complex JavaScript:
+
+```html
+<!-- Reactive forms -->
+<form hx-post="/api/submit" hx-target="#result">
+  <input type="text" name="data">
+  <button type="submit">Submit</button>
+</form>
+
+<!-- Real-time updates -->
+<div hx-ext="sse" sse-connect="/events" sse-swap="message">
+  Updates will appear here
+</div>
+```
+
+### Styling with Tailwind + DaisyUI
+
+```html
+<!-- Utility classes + Components -->
+<button class="btn btn-primary">
+  Click Me
+</button>
+
+<div class="card bg-base-100 shadow-xl">
+  <div class="card-body">
+    <h2 class="card-title">Card Title</h2>
+    <p>Card content</p>
+  </div>
+</div>
+```
+
+## Documentation
+
+For complete documentation, guides, and examples, see the main Vibetuner repository:
+
+**📖 [Vibetuner Documentation](https://github.com/alltuner/vibetuner#readme)**
+
+## Package Ecosystem
+
+Vibetuner consists of three packages that work together:
+
+1. **[vibetuner](https://pypi.org/project/vibetuner/)**: Python framework and dependencies
+2. **@alltuner/vibetuner** (this package): JavaScript/CSS build dependencies
+3. **Scaffolding template**: Copier template for project generation
+
+All three are version-locked and tested together to ensure compatibility.
+
+## Contributing
+
+Contributions welcome! See the main repository for contribution guidelines:
+
+**🤝 [Contributing to Vibetuner](https://github.com/alltuner/vibetuner/blob/main/CONTRIBUTING.md)**
+
 ## License
 
-MIT
+MIT License - Copyright (c) 2025 All Tuner Labs, S.L.
+
+See [LICENSE](https://github.com/alltuner/vibetuner/blob/main/LICENSE) for details.
 
-## Repository
+## Links
 
-<https://github.com/alltuner/vibetuner>
+- **Main Repository**: https://github.com/alltuner/vibetuner
+- **Documentation**: https://github.com/alltuner/vibetuner#readme
+- **Issues**: https://github.com/alltuner/vibetuner/issues
+- **npm**: https://www.npmjs.com/package/@alltuner/vibetuner
+- **Python Package**: https://pypi.org/project/vibetuner/

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@alltuner/vibetuner",
-  "version": "2.8.3",
-  "description": "Blessed JavaScript/frontend build dependencies for Vibetuner projects",
+  "version": "2.9.1",
+  "description": "Blessed JavaScript/frontend build dependencies for production-ready Vibetuner projects",
   "keywords": [
     "tailwindcss",
     "htmx",
     "daisyui",
     "frontend",
-    "build-tools"
+    "build-tools",
+    "web-framework",
+    "fastapi"
   ],
   "license": "MIT",
-  "author": "AllTuner",
+  "author": "All Tuner Labs, S.L.",
   "repository": {
     "type": "git",
     "url": "https://github.com/alltuner/vibetuner",