From 27287238aa12fee2884ec997fec1c1ffa5839f7b Mon Sep 17 00:00:00 2001 From: Nexmoe <16796652+nexmoe@users.noreply.github.com> Date: Sat, 8 Nov 2025 18:56:57 +0800 Subject: [PATCH] feat: rewrite README header and intro with badges and (#20) --- README.md | 125 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 73 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index b28c164..abd8752 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,37 @@ -# 🐝 VidBee -
- VidBee icon -

Download videos from almost any website worldwide

-

Best-in-class UI interface - Clean, intuitive, and powerful

-

Built with Electron, React, TypeScript, Tailwind CSS, and shadcn/ui.

+ + Logo + + +

VidBee

+

+ + + + + +
+
+ VidBee Desktop + VidBee Download Queue +
+
+

-## ✨ Core Features +VidBee is a modern, open-source video downloader that lets you download videos and audios from 1000+ websites worldwide. Built with Electron and powered by yt-dlp, VidBee offers a clean, intuitive interface with powerful features for all your downloading needs. -### 🌍 Global Video Download Support +## 👋🏻 Getting Started -- **1000+ Sites Supported** - Download videos from almost any website worldwide through yt-dlp engine -- **Smart Platform Detection** - Automatically detect video platforms and optimize download parameters -- **Multi-format Support** - Videos, audio tracks, playlists to meet all download needs -- Localized interface support in many languages +VidBee is currently under active development, and feedback is welcome for any [issue](https://github.com/nexmoe/VidBee/issues) encountered. -### 🎨 Best-in-class UI Experience +Feel free to try it using the following methods: -- **Modern Design** - Clean and beautiful interface -- **Intuitive Operations** - One-click pause/resume/retry -- **Real-time Progress** - Detailed download progress tracking and status management -- **Theme Switching** - Support for system/light/dark themes for comfortable viewing - -## 📥 Download & Install - -1. **Download the latest release** from [GitHub Releases](https://github.com/nexmoe/VidBee/releases) -2. **Choose your platform**: - - **Windows**: Download `vidbee-x.x.x-setup.exe` - - **macOS**: Download `vidbee-x.x.x.dmg` - - **Linux**: Download `vidbee-x.x.x.AppImage` -3. **Install and run** the application +| Operating System | Source | +| :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Windows | | +| macOS | | +| Linux | | ### 🍎 macOS Installation Notes @@ -42,49 +43,69 @@ xattr -rd com.apple.quarantine /Applications/VidBee.app/ This command removes the quarantine attribute that macOS applies to applications downloaded from the internet, allowing VidBee to run properly without the "file is damaged" error. -## 📸 Screenshots +> [!IMPORTANT] +> +> **Star Us**, You will receive all release notifications from GitHub without any delay ~ + + + + + Performance Stats of nexmoe/VidBee - Last 28 days + + + + + +## ✨ Features + +### 🌍 Global Video Download Support + +Download videos from almost any website worldwide through the powerful yt-dlp engine. Support for 1000+ sites including YouTube, TikTok, Instagram, Twitter, and many more. ![VidBee Main Interface](screenshots/main-interface.png) -*Clean and intuitive interface with download queue management* + +### 🎨 Best-in-class UI Experience + +Modern, clean interface with intuitive operations. One-click pause/resume/retry, real-time progress tracking, and comprehensive download queue management. ![VidBee Download Queue](screenshots/download-queue.png) -*Comprehensive download queue with progress tracking and status management* ## 🌐 Supported Sites VidBee supports hundreds of video and audio platforms through yt-dlp. Here are the most popular platforms: | Video Platforms | Audio & Other Platforms | -| --- | --- | -| YouTube | YouTube Music | -| TikTok | SoundCloud | -| Facebook | Mixcloud | -| Instagram | Bandcamp | -| X (Twitter) | Reddit | -| Vimeo | | -| Dailymotion | | -| Twitch | | -| LinkedIn | | -| Pinterest | | -| Tumblr | | -| Niconico | | -| Kick | | +| :--------------- | :---------------------- | +| YouTube | YouTube Music | +| TikTok | SoundCloud | +| Facebook | Mixcloud | +| Instagram | Bandcamp | +| X (Twitter) | Reddit | +| Vimeo | | +| Dailymotion | | +| Twitch | | +| LinkedIn | | +| Pinterest | | +| Tumblr | | +| Niconico | | +| Kick | | > **💡 Note:** VidBee uses [yt-dlp](https://github.com/yt-dlp/yt-dlp) under the hood, which supports 1000+ sites. For the complete list, visit the [yt-dlp supported sites documentation](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md). -## ?? Contributing +## 🤝 Contributing -Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) for guidelines on reporting issues, proposing features, and opening pull requests. It also covers the tech stack, development workflow, scripts, internationalization notes, configuration guidance, and packaging steps. +You are welcome to join the open source community to build together. Please check our [Contributing Guide](./CONTRIBUTING.md) for more details. ## 📄 License -This project is distributed under the MIT License. See `LICENSE` for details. +This project is distributed under the MIT License. See [`LICENSE`](LICENSE) for details. ## 🙏 Thanks -- [yt-dlp](https://github.com/yt-dlp/yt-dlp) -- [Electron](https://www.electronjs.org/) -- [React](https://react.dev/) -- [Vite](https://vitejs.dev/) -- [Tailwind CSS](https://tailwindcss.com/) -- [shadcn/ui](https://ui.shadcn.com/) +- [yt-dlp](https://github.com/yt-dlp/yt-dlp) - The powerful video downloader engine +- [FFmpeg](https://ffmpeg.org/) - The multimedia framework for video and audio processing +- [Electron](https://www.electronjs.org/) - Build cross-platform desktop apps +- [React](https://react.dev/) - The UI library +- [Vite](https://vitejs.dev/) - Next generation frontend tooling +- [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework +- [shadcn/ui](https://ui.shadcn.com/) - Beautifully designed components