Refactor README.md for improved readability and clarity

Author: Thavarshan

README.md

@@ -8,55 +8,69 @@
 </p>
 
 > [!WARNING]
-> We don't have an Apple Developer account yet, and the application is not code-signed for both Mac and Windows. Therefore, the applications will show a warning popup on the first start. On Mac, click **Okay**, then go to **Settings / Privacy & Security** and scroll down until you see a button **Open anyway**. You'll have to do this once. On Windows, you may see a warning message indicating that the app is from an unknown publisher. Click **More info** and then **Run anyway** to proceed.
+> **We don't have an Apple Developer account yet, and the application is not code-signed for both Mac and Windows. Therefore, the applications will show a warning popup on the first start.**
+> On **Mac**, click **Okay**, then go to **Settings / Privacy & Security** and scroll down until you see a button **Open anyway**.
+> On **Windows**, you may see a warning message indicating that the app is from an unknown publisher. Click **More info** and then **Run anyway** to proceed.
+
+---
 
 ## About Comet
 
-**Comet** is a cross-platform media converter application designed to make the conversion of video, audio, and image files as easy and accessible as possible. Leveraging the power of [FFmpeg](https://ffmpeg.org/), Comet allows users to convert various media formats all within a simple, intuitive interface.
+**Comet** is a cross-platform media converter application designed to make the conversion of video, audio, and image files as easy and accessible as possible. Built on top of [FFmpeg](https://ffmpeg.org/), **Jimp**, and **Electron**, Comet offers a seamless and efficient user experience for media conversions, all within a simple, intuitive interface.
 
 ![Comet UI 1](./assets/screenshot_1.png)
 ![Comet UI 2](./assets/screenshot_2.png)
 ![Comet UI 3](./assets/screenshot_3.png)
 ![Comet UI 4](./assets/screenshot_4.png)
 
+---
+
 ## Project Overview
 
-Comet's goal is to provide a free, user-friendly, and visually appealing application for converting media files. Whether you need to convert a single file or multiple files at once, Comet is here to help.
+Comet's goal is to provide a **free, user-friendly, and visually appealing** application for converting media files. Whether you need to convert a single file or multiple files at once, Comet is designed to make the process straightforward.
 
 ### Key Features
 
-- **Cross-Platform Compatibility:** Runs on macOS, Windows, and Linux.
-- **Video, Audio, and Image Conversion:** Supports conversion to a wide range of video formats (MP4, MKV, AVI, MOV, etc.), audio formats (MP3, WAV, AAC, FLAC, etc.), and image formats (JPEG, PNG, BMP, etc.).
+- **Cross-Platform Compatibility:** Works seamlessly on macOS, Windows, and Linux.
+- **Video, Audio, and Image Conversion:**
+  - Video formats: MP4, MKV, AVI, MOV, etc.
+  - Audio formats: MP3, WAV, AAC, FLAC, etc.
+  - Image formats: JPEG, PNG, BMP, ICO, ICNS, etc.
 - **Bulk File Conversion:** Easily upload and convert multiple files in one go.
-- **User-Friendly Interface:** A clean and intuitive UI that simplifies the conversion process.
-- **Real-Time Conversion Feedback:** Conversion progress is tracked and displayed to the user, with real-time updates and error handling.
-- **Fast Conversion:** Powered by FFmpeg, known for its speed and efficiency in media processing.
-- **Dark Mode:** Provides a dark theme for users who prefer a more comfortable visual experience.
+- **Real-Time Progress Tracking:** Track the progress of each conversion with real-time feedback.
+- **Dark Mode:** A sleek dark theme for more comfortable use.
 - **Multi-Language Support:** Available in multiple languages for a global audience.
+- **Cancel/Resume Conversions:** Cancel ongoing conversions, with options to manage individual items in the queue.
+- **Jimp and FFmpeg Integration:** Use Jimp for images and FFmpeg for audio/video conversion.
+
+---
 
-### Current Status
+## Recent Updates
 
-The project has made significant progress:
+- **Unified Conversion Handler:** We’ve refactored the media conversion process to use an **Adapter Pattern**, allowing for a unified conversion handler for video, audio, and image files using either **FFmpeg** or **Jimp** depending on the file type.
+- **Advanced Testing:** Expanded unit tests using **Jest** to cover media conversion handlers and IPC processes.
+- **Improved Performance:** Faster conversions through optimizations to how we handle bulk file uploads and media processing queues.
+- **Enhanced UI and UX:** More responsive interface and clearer progress tracking for large file batches.
 
-- **Basic UI and Core Functionality:** The user interface is fully implemented, supporting bulk file uploads, conversion status tracking, and real-time feedback.
-- **FFmpeg Integration:** The core video, audio, and image conversion functionality is complete, making the app fully functional.
-- **Cross-Platform Distributables:** Distributables for macOS, Windows, and Linux have been successfully created. However, due to the high cost of an Apple Developer membership, the app is currently not code-signed or notarized for macOS, which may present challenges when running it on Mac devices.
+---
 
 ## Technologies Used
 
 - **Electron:** For building the cross-platform desktop application.
 - **Vue.js (with Composition API and TypeScript):** For the frontend UI.
-- **FFmpeg:** The core engine for media format conversion.
-- **Node.js:** Backend services and script automation.
-- **Vite:** For fast and modern build tooling.
+- **FFmpeg & Jimp:** Core engines for media conversion (video/audio via FFmpeg, images via Jimp).
+- **Node.js:** Backend services and media processing.
+- **Vite:** Modern build tool for fast development.
 - **Tailwind CSS:** For styling and responsive design.
-- **i18n:** For handling internationalization and multiple language support.
+- **i18n:** Internationalization for multi-language support.
 - **Jest:** For unit testing.
-- **GitHub Actions:** For CI/CD and release automation.
+- **GitHub Actions:** Continuous Integration/Continuous Deployment (CI/CD) and release automation.
 
-### Getting Started
+---
 
-To get started with development:
+## Getting Started
+
+To get started with Comet:
 
 1. **Clone the repository:**
 
@@ -84,55 +98,53 @@ To get started with development:
    ```
 
 5. **Test your changes:**
-   - Ensure your changes do not break existing functionality.
-   - Write unit tests if possible and applicable.
 
-## Roadmap
+   ```bash
+   npm run test
+   ```
 
-- **Phase 1:** Basic UI Implementation (Completed)
-  - File upload functionality.
-  - Simple file selection and list management.
+---
 
-- **Phase 2:** FFmpeg Integration (Completed)
-  - Implement core conversion functionality.
-  - Support for multiple video formats.
-  - Real-time conversion feedback.
+## Roadmap
 
-- **Phase 3:** UI Enhancements and Customization Options (Completed)
-  - Output format selection and settings.
-  - Batch processing capabilities.
+- **Phase 1:** Basic UI Implementation (Completed)
+  - File upload functionality, file list management.
 
-- **Phase 4:** Cross-Platform Testing and Release (In Progress)
-  - Test and refine the app on macOS, Windows, and Linux.
-  - **Package the app for distribution** on various platforms.
-  - **Overcome code signing challenges**, particularly on macOS due to the cost of an Apple Developer membership.
-  - Prepare for the first public release.
+- **Phase 2:** FFmpeg & Jimp Integration (Completed)
+  - Core conversion functionality for video, audio, and images.
 
-## Support
+- **Phase 3:** UI Enhancements (Completed)
+  - Improved conversion progress tracking and batch conversion options.
 
-If you find this project helpful or interesting, please consider giving it a ⭐. Your support and feedback are greatly appreciated!
+- **Phase 4:** Cross-Platform Testing and Releases (In Progress)
+  - Testing on macOS, Windows, and Linux.
+  - Package the app for distribution across platforms.
+  - Address macOS code-signing challenges (currently blocked by lack of Apple Developer account).
 
-## Contributors
+---
 
-- **Jerome Thayananthajothy** - Project Lead & Developer
-- [**Contributors List**](https://github.com/stellar-comet/comet/graphs/contributors) - A big thank you to all the amazing contributors!
+## Contributing
 
-## How to Contribute
+Contributions are welcome! Here’s how you can contribute:
 
-We welcome contributions and collaboration! Whether you're a seasoned developer or just starting out, there's a place for you in our project. Here's how you can help:
+1. **Fork the Repository:** Create a fork of this repository.
+2. **Clone the Repo:** Clone the forked repository to your local machine.
+3. **Create a Branch:** Create a new branch for your feature or fix.
+4. **Make Your Changes:** Ensure your changes work as expected and pass tests.
+5. **Submit a Pull Request:** Once done, submit a PR to the `main` branch.
+6. **Star the Repo:** If you like Comet, please give it a ⭐!
 
-1. **Fork the Repository:** Start by forking this repository to your GitHub account.
-2. **Clone the Repo:** Clone the forked repo to your local machine using `git clone`.
-3. **Set Up the Environment:** Follow the steps below to get the project running on your local machine.
-4. **Create a Branch:** Create a new branch for the feature or fix you plan to work on.
-5. **Submit a Pull Request:** Once your changes are ready, submit a pull request to the `main` branch of this repository.
-6. **Star the Repository:** If you like this project, please give it a star on GitHub. It helps us gain visibility and grow our community!
+---
 
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
+---
+
 ## Acknowledgements
 
-- [FFmpeg](https://ffmpeg.org/) - The powerful multimedia framework that makes this project possible.
-- The Electron and Vue.js communities for their fantastic tools and support.
+- [FFmpeg](https://ffmpeg.org/) - The powerful multimedia framework that powers video/audio conversion in Comet.
+- [Jimp](https://github.com/oliver-moran/jimp) - Image processing in Comet.
+- [Electron](https://www.electronjs.org/) - For building cross-platform desktop apps.
+- The [Vue.js](https://vuejs.org/) and [Tailwind CSS](https://tailwindcss.com/) communities for their fantastic tools and support.