musify 1.0.2 → 1.0.3

package/README.md

@@ -1,37 +1,46 @@
-# 🎵 Musify
+<div align="center">
+
+# 🎧 Musify
 
-> **Professional Music Card Generator for Discord Bots**  
+> **Professional Music Image Generator for Discord Bots**  
 > *Create stunning, high-performance music cards with elegant glass design and automatic color extraction*
 
-[![npm version](https://img.shields.io/npm/v/musify.svg?style=flat-square)](https://www.npmjs.com/package/musify)
-[![npm downloads](https://img.shields.io/npm/dm/musify.svg?style=flat-square)](https://www.npmjs.com/package/musify)
-[![License](https://img.shields.io/npm/l/musify.svg?style=flat-square)](https://github.com/Zokys/musify/blob/main/LICENSE)
+<br>
+
+[![npm version](https://img.shields.io/npm/v/musify.svg?style=flat-square)](https://www.npmjs.com/package/musify) 
+[![npm downloads](https://img.shields.io/npm/dm/musify.svg?style=flat-square)](https://www.npmjs.com/package/musify) 
+[![License](https://img.shields.io/npm/l/musify.svg?style=flat-square)](https://github.com/Zokys/musify/blob/main/LICENSE) 
 [![Node.js](https://img.shields.io/node/v/musify.svg?style=flat-square)](https://nodejs.org/)
 
-<div align="center">
+<br><br>
+
+# 👀 Preview
+
+<img src="https://i.imgur.com/5lEfqA7.png" alt="Musify Preview 1" width="70%" /><br><br>
 
-![Musify Preview](https://via.placeholder.com/800x200/1c1c1c/FF7A00?text=Musify+Music+Card+Generator)
+<img src="https://i.imgur.com/fZdYnAX.png" alt="Musify Preview 2" width="70%" /><br>
 
-*Elegant music cards for your Discord bot*
+<img src="https://i.imgur.com/ztCvUln.png" alt="Musify Preview 3" width="70%" /><br>
 
 </div>
 
+
 ---
 
 ## ✨ Features
 
 | Feature | Description |
 |---------|-------------|
-| 🎨 **Glass Design** | Modern, clean music card layout with rounded corners and shadows |
+| 🔎 **Glass Design** | Modern, clean music card layout with rounded corners and shadows |
 | 🎯 **Auto Color Extraction** | Intelligently extracts dominant colors from thumbnails |
-| 🌟 **Background Effects** | Blur, darkness, and overlay controls for stunning visuals |
+| 🪅 **Background Effects** | Blur, darkness, and overlay controls for stunning visuals |
 | 📏 **Flexible Scaling** | Scale from 0.5x to 2x for different use cases |
 | ⚡ **High Performance** | Optimized rendering with minimal memory footprint |
 | 🔧 **TypeScript Ready** | Full TypeScript definitions and IntelliSense support |
 | 🎵 **Riffy Integration** | Perfect compatibility with Riffy music library |
 | 🖼️ **Multiple Formats** | Support for URLs, local paths, and buffer inputs |
 
-## 🚀 Quick Start
+## 🤔 Quick Start
 
 ### Installation
 
@@ -44,7 +53,7 @@ npm install musify
 ```typescript
 import { Glass } from 'musify';
 
-const musicCard = await Glass({
+const Musify = await Glass({
   thumbnailImage: 'https://example.com/thumbnail.jpg',
   name: 'Bohemian Rhapsody',
   author: 'Queen',
@@ -55,12 +64,12 @@ const musicCard = await Glass({
 });
 ```
 
-### Send to Discord
+### Send to Discord Channel
 
 ```typescript
 await channel.send({
   files: [{ 
-    attachment: musicCard, 
+    attachment: Musify, 
     name: 'now-playing.png' 
   }]
 });
@@ -68,14 +77,6 @@ await channel.send({
 
 ---
 
-## 🎨 API Reference
-
-### Glass Function
-
-```typescript
-Glass(options: MusifyOptions): Promise<Buffer>
-```
-
 Generates a professional music card and returns a PNG buffer.
 
 ### Configuration Options
@@ -102,12 +103,12 @@ Generates a professional music card and returns a PNG buffer.
 
 ---
 
-## 🎯 Advanced Examples
+## 🎯 Usage Examples
 
 ### Auto Color Extraction
 
 ```typescript
-const musicCard = await Glass({
+const Musify = await Glass({
   thumbnailImage: track.info.thumbnail,
   name: track.info.title,
   author: track.info.author,
@@ -125,7 +126,7 @@ const musicCard = await Glass({
 ### Custom Styling
 
 ```typescript
-const musicCard = await Glass({
+const Musify = await Glass({
   thumbnailImage: 'https://example.com/thumbnail.jpg',
   name: 'Custom Styled Track',
   author: 'Custom Artist',
@@ -146,7 +147,7 @@ const musicCard = await Glass({
 ### Background Effects
 
 ```typescript
-const musicCard = await Glass({
+const Musify = await Glass({
   thumbnailImage: track.info.thumbnail,
   backgroundImage: track.info.thumbnail, // Use same image as background
   backgroundBlur: 20, // Strong blur effect
@@ -171,7 +172,7 @@ import { Glass } from 'musify';
 
 // Track start event
 client.riffy.on('trackStart', async (player, track) => {
-  const musicCard = await Glass({
+  const Musify = await Glass({
     thumbnailImage: track.info.thumbnail,
     name: track.info.title,
     author: track.info.author,
@@ -184,7 +185,7 @@ client.riffy.on('trackStart', async (player, track) => {
   
   // Send to Discord
   await player.textChannel.send({
-    files: [{ attachment: musicCard, name: 'now-playing.png' }]
+    files: [{ attachment: Musify, name: 'now-playing.png' }]
   });
 });
 
@@ -195,7 +196,7 @@ setInterval(async () => {
     const startTime = formatTime(player.position);
     const endTime = formatTime(player.current.info.length);
     
-    const musicCard = await Glass({
+    const Musify = await Glass({
       thumbnailImage: player.current.info.thumbnail,
       name: player.current.info.title,
       author: player.current.info.author,
@@ -207,7 +208,7 @@ setInterval(async () => {
     });
     
     // Update message
-    await message.edit({ files: [{ attachment: musicCard, name: 'now-playing.png' }] });
+    await message.edit({ files: [{ attachment: Musify, name: 'now-playing.png' }] });
   }
 }, 5000); // Update every 5 seconds
 
@@ -222,7 +223,7 @@ function formatTime(ms: number): string {
 
 ## ⚡ Performance Optimization
 
-### 1. **Reuse Configuration Objects**
+###  **Reuse Configuration Objects**
 
 ```typescript
 const baseConfig = {
@@ -233,7 +234,7 @@ const baseConfig = {
 };
 
 // Reuse for different tracks
-const musicCard1 = await Glass({
+const Musify1 = await Glass({
   ...baseConfig,
   thumbnailImage: track1.info.thumbnail,
   name: track1.info.title,
@@ -241,7 +242,7 @@ const musicCard1 = await Glass({
   progress: 30
 });
 
-const musicCard2 = await Glass({
+const Musify2 = await Glass({
   ...baseConfig,
   thumbnailImage: track2.info.thumbnail,
   name: track2.info.title,
@@ -250,7 +251,7 @@ const musicCard2 = await Glass({
 });
 ```
 
-### 2. **Cache Generated Cards**
+###  **Cache Generated Cards**
 
 ```typescript
 const cardCache = new Map();
@@ -262,8 +263,8 @@ async function getCachedCard(trackId: string, progress: number) {
     return cardCache.get(cacheKey);
   }
   
-  const musicCard = await Glass(options);
-  cardCache.set(cacheKey, musicCard);
+  const Musify = await Glass(options);
+  cardCache.set(cacheKey, Musify);
   
   // Limit cache size
   if (cardCache.size > 100) {
@@ -271,180 +272,8 @@ async function getCachedCard(trackId: string, progress: number) {
     cardCache.delete(firstKey);
   }
   
-  return musicCard;
-}
-```
-
-### 3. **Batch Processing**
-
-```typescript
-async function generateMultipleCards(tracks: Track[]) {
-  const promises = tracks.map(track => 
-    Glass({
-      thumbnailImage: track.thumbnail,
-      name: track.title,
-      author: track.author,
-      progress: 0
-    })
-  );
-  
-  return await Promise.all(promises);
+  return Musify;
 }
 ```
 
----
-
-## 🛠️ Development
-
-### Building from Source
-
-```bash
-# Clone repository
-git clone https://github.com/Zokys/musify.git
-cd musify
-
-# Install dependencies
-npm install
-
-# Build package
-npm run build
-
-# Run tests
-npm test
-```
-
-### Development Mode
-
-```bash
-# Watch for changes
-npm run dev
-
-# Clean build
-npm run clean && npm run build
-```
-
-### Project Structure
-
-```
-musify/
-├── src/
-│   ├── index.ts              # Main entry point
-│   ├── renderers/
-│   │   └── glassRenderer.ts  # Core rendering logic
-│   ├── utils/
-│   │   ├── colorExtractor.ts # Color extraction
-│   │   ├── textProcessor.ts  # Text utilities
-│   │   └── fontManager.ts    # Font management
-│   ├── types/
-│   │   └── index.ts          # TypeScript definitions
-│   └── fonts/                # Font assets
-├── dist/                     # Compiled output
-├── package.json
-└── README.md
-```
-
----
-
-## 🐛 Error Handling
-
-```typescript
-try {
-  const musicCard = await Glass({
-    thumbnailImage: track.info.thumbnail,
-    name: track.info.title,
-    author: track.info.author,
-    requester: track.info.requester.username,
-    progress: 25,
-    startTime: '1:15',
-    endTime: '4:30'
-  });
-  
-  await channel.send({
-    files: [{ attachment: musicCard, name: 'music.png' }]
-  });
-  
-} catch (error) {
-  console.error('Failed to generate music card:', error.message);
-  
-  // Fallback to text message
-  await channel.send({
-    embeds: [{
-      title: '🎵 Now Playing',
-      description: `${track.info.title} by ${track.info.author}`,
-      color: 0xFF7A00
-    }]
-  });
-}
-```
-
----
-
-## 📊 Benchmarks
-
-| Operation | Time | Memory |
-|-----------|------|--------|
-| Basic Card Generation | ~50ms | ~2MB |
-| With Auto Color Extraction | ~80ms | ~3MB |
-| With Background Effects | ~120ms | ~4MB |
-| High Resolution (2x scale) | ~200ms | ~8MB |
-
-*Tested on Node.js 18+ with 8GB RAM*
-
----
-
-## 🤝 Contributing
-
-We welcome contributions! Here's how to get started:
-
-1. **Fork** the repository
-2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
-3. **Commit** your changes (`git commit -m 'Add amazing feature'`)
-4. **Push** to the branch (`git push origin feature/amazing-feature`)
-5. **Open** a Pull Request
-
-### Development Guidelines
-
-- Follow TypeScript best practices
-- Add tests for new features
-- Update documentation
-- Ensure cross-platform compatibility
-- Optimize for performance
-
----
-
-## 📄 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
----
-
-## 🆘 Support
-
-### Getting Help
-
-- 📖 **Documentation**: Check this README and examples
-- 🐛 **Issues**: [GitHub Issues](https://github.com/Zokys/musify/issues)
-- 💬 **Discussions**: [GitHub Discussions](https://github.com/Zokys/musify/discussions)
-- 📧 **Email**: Contact the maintainers directly
-
-### Common Issues
-
-| Issue | Solution |
-|-------|----------|
-| Font loading errors | Ensure fonts are in `src/fonts/` directory |
-| Color extraction fails | Check thumbnail URL accessibility |
-| Memory issues | Reduce scale or optimize image sizes |
-| Performance problems | Use caching and batch processing |
-
----
-
-<div align="center">
-
-**Made with ❤️ for the Discord bot community**
-
-[![GitHub stars](https://img.shields.io/github/stars/Zokys/musify?style=social)](https://github.com/Zokys/musify)
-[![GitHub forks](https://img.shields.io/github/forks/Zokys/musify?style=social)](https://github.com/Zokys/musify)
-
-*Star this repository if it helped you! ⭐*
 
-</div> 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musify",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Powerful and elegant music image generator for Discord bots featuring high performance, customizable designs, and seamless integration.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",