diff --git a/README.md b/README.md index 94a5105..1306696 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,12 @@ WinQuickLook

- A lightweight file viewer like "Quick Look" on macOS. + Bring macOS Quick Look to Windows

+

+ Preview files instantly with a single keystroke—no need to open applications +

+

Build Build @@ -16,34 +20,83 @@ License

-## How to install +--- + +## ✨ Overview + +WinQuickLook is a fast, lightweight file previewer for Windows that brings the beloved macOS Quick Look experience to your PC. Simply select a file in File Explorer and press Space to instantly preview it—no waiting for applications to launch. + +Perfect for quickly browsing through documents, images, videos, and more without the hassle of opening full applications. -### Microsoft Store +## 🎯 Features + +- **⚡ Lightning Fast** - Instant file previews without opening heavy applications +- **🎨 Wide Format Support** - Preview images, documents, videos, audio files, and more +- **⌨️ Simple Keyboard Shortcut** - Just press Space to preview, Esc to close +- **🪶 Lightweight** - Minimal resource usage, runs quietly in the background +- **🎨 Modern UI** - Clean, intuitive interface that fits seamlessly with Windows +- **🔄 Seamless Integration** - Works directly with Windows File Explorer + +## 📦 Installation + +### Option 1: Microsoft Store (Recommended) + +Get the app directly from the Microsoft Store for automatic updates: Download now -### WinGet +### Option 2: WinGet -``` +Install via command line using Windows Package Manager: + +```bash winget install 9NJMTKK6JC0Q --source msstore ``` + or -``` + +```bash winget install WinQuickLook --source msstore ``` -## Usage +## 🚀 Quick Start + +1. **Install & Launch** - Download WinQuickLook and launch the application +2. **Browse Files** - Open any folder in Windows File Explorer +3. **Select a File** - Click on any file you want to preview +4. **Press Space** - Instantly preview the file content +5. **Press Esc** - Close the preview and continue browsing + +That's it! WinQuickLook will run in the background, ready whenever you need it. + +## 💡 Use Cases -1. Launch `WinQuickLook` -2. Open folder in explorer -3. Select a file -4. Press a space key +- **Quick Document Review** - Scan through multiple documents without opening Word, PDF readers, etc. +- **Image Browsing** - Preview photos instantly while organizing your photo library +- **Code Review** - Quickly check source code files without launching your IDE +- **Media Preview** - Check video or audio content before opening in a full media player +- **File Management** - Verify file contents while cleaning up folders -## Supported OS versions +## 🖥️ System Requirements - Windows 10 Version 1903 or later - Windows 11 -## License +## 🤝 Contributing + +We welcome contributions! Whether it's bug reports, feature requests, or code contributions, we appreciate your help in making WinQuickLook better. + +- **Report Issues** - [GitHub Issues](https://github.com/polymind-inc/WinQuickLook/issues) +- **Feature Requests** - Share your ideas for new features +- **Pull Requests** - Contribute code improvements + +## 📄 License This project is licensed under the [Apache License 2.0](https://github.com/polymind-inc/WinQuickLook/blob/master/LICENSE) + +## ⭐ Show Your Support + +If you find WinQuickLook useful, please consider: +- ⭐ Starring this repository +- 🐦 Sharing with your friends and colleagues +- 💬 Leaving a review on the Microsoft Store