Skip to content

GITHUB_RELEASE_TEXT.md

Latest commit

 

History

History
203 lines (147 loc) · 4.86 KB

GITHUB_RELEASE_TEXT.md

File metadata and controls

203 lines (147 loc) · 4.86 KB

🎉 v1.0.0 - Initial Public Release

The simplest way to package web apps for multiple platforms!

⚡ Quick Start

git clone https://github.com/mehmetnadir/electron-multi-platform-packager.git
cd electron-multi-platform-packager
npm install
npm run electron

That's it! Start packaging your apps in 5 minutes! 🚀

🌟 What's New

First Public Release!

  • ✅ Multi-platform packaging (Windows, macOS, Linux, Android, PWA)
  • ✅ Automatic icon generation (25+ formats from one PNG!)
  • ✅ Zero configuration required
  • ✅ Real-time progress tracking
  • ✅ Queue management
  • ✅ Modern web UI

🎨 The Magic

Upload one 512x512 PNG → Get 25+ optimized icons automatically:

  • Windows ICO (6 sizes)
  • macOS ICNS (6 sizes)
  • Linux PNG (optimized)
  • Android icons (5 densities)
  • PWA icons (8 sizes)

⚡ Time Savings

  • Traditional way: 6+ hours per app
  • Our way: 5 minutes per app
  • Savings: 97%! 🎯

📦 Installation

Option 1: Clone Repository (Recommended)

git clone https://github.com/mehmetnadir/electron-multi-platform-packager.git
cd electron-multi-platform-packager
npm install
npm run electron

Option 2: Download Source ZIP

  1. Download Source code (zip) below
  2. Extract and open terminal in folder
  3. Run: npm install && npm run electron

📚 Full Installation Guide: RELEASE_INSTALLATION.md

📖 Documentation

✨ Key Features

🎯 Multi-Platform Support

Platform Output Features
🪟 Windows EXE + Installer Code signing ready
🍎 macOS DMG Notarization ready
🐧 Linux AppImage + DEB Portable
🤖 Android APK Via Capacitor
🌐 PWA Web App Offline support

🚀 Zero Configuration

  1. Upload your web app ZIP
  2. Add one PNG logo (optional)
  3. Click "Start Packaging"
  4. Done! Download your packages

📊 Real-time Progress

  • Live progress tracking
  • Queue management
  • Detailed status updates
  • Error handling

🎓 Example Usage

Package a React App

# Build your React app
cd my-react-app
npm run build

# Create ZIP
cd build && zip -r ../react-app.zip .

# Open Electron Multi-Platform Packager
# Upload react-app.zip
# Add logo (optional)
# Select platforms
# Click "Start Packaging"
# Download packages!

Result: Windows EXE, macOS DMG, Linux AppImage in ~5 minutes! ⚡

🛠️ Requirements

  • Node.js: 18.0.0 or higher
  • RAM: 4GB minimum (8GB recommended)
  • Disk: 10GB free space
  • OS: Windows, macOS, or Linux

Platform-Specific

  • Windows packaging: Windows 10/11 or Wine
  • macOS packaging: macOS 10.13+ with Xcode CLI
  • Linux packaging: Any modern Linux distribution
  • Android packaging: Java JDK 17

🤝 Contributing

We welcome contributions! See CONTRIBUTING.md

Ways to contribute:

  • 🐛 Report bugs
  • 💡 Suggest features
  • 📚 Improve documentation
  • 🧪 Add tests
  • 🌍 Add translations

📝 License

MIT License - Free for commercial and non-commercial use

🙏 Acknowledgments

Built with:

🗺️ Roadmap

v1.1.0 (Planned)

  • iOS support
  • Snap package
  • Flatpak support
  • Windows Store (MSIX)

v1.2.0 (Planned)

  • Automated testing
  • Plugin system
  • Multi-language UI
  • Cloud builds

📧 Support

📊 Release Stats

  • Version: 1.0.0
  • Release Date: October 28, 2025
  • Platforms: 5 (Windows, macOS, Linux, Android, PWA)
  • Auto Icons: 25+ formats
  • Time Saved: 97%
  • License: MIT

⭐ Star us on GitHub if you find this useful!

Made with ❤️ for the developer community

Making multi-platform packaging accessible to everyone