first release

README.md

@@ -0,0 +1,54 @@
+# Custom Logo Image Maker Tool for POCO X3 Pro
+
+### A simple to use CLI Tool to Create Custom Splash Screen / Boot Logo for your POCO X3 Pro (vayu) device!<br></br>
+[![status](https://img.shields.io/badge/status-active-brightgreen.svg?style=flat)](https://github.com/neosubhamoy/poco-x3-pro-custom-logo-image-maker/)
+[![release verion](https://img.shields.io/badge/release-v1.1.0-yellow.svg?style=flat)](https://github.com/neosubhamoy/poco-x3-pro-custom-logo-image-maker/releases/)
+<br></br>
+
+**🌟 Highlights:**
+1. Really Simple To Use (1-click-process)
+2. Both 'logo.img' & Recovery Flashable ZIP file Support
+3. Auto .bmp Format Conversion (Multi File Format Support - .bmp, .jpg, .jpeg, .png, .gif)
+4. Quick Restore (Revert back to default POCO logo)
+
+**✔️ Compatibility:**
+1. DEVICE: POCO X3 Pro (vayu/bhima) - Tested on both Global and Indian variants - <span style='color:#fc4454'>** Don't Use For Other Devices **</span>
+2. ROM: Any Android 11+ AOSP/MIUI based ROM
+3. PLATFORM: Currently this tool only works on Windows (Linux & Android support coming soon...!!)
+4. LANGUAGE: ENG (US)
+
+**⚡ Pre-Requirements:**
+1. UNLOCKED Device Bootloader
+2. Any Custom Recovery (TWRP/OrangeFox) is Installed (Optional - if you don't want to flash the recovery flashable zip file)
+
+**⚙️ How To Use:**
+1. Read this detailed [How To Use Guide on XDA Forums](https://forum.xda-developers.com/t/xiaomi-poco-x3-pro.12163/)
+
+**⚠️ DISCLAIMER:**
+
+```code
+!!! USE THIS TOOL AT YOUR OWN RESPONSIBILITY !!!
+
+* Your warranty is now void.
+
+*
+
+* I'm not responsible for bricked devices, dead SD cards,
+
+* thermonuclear war, or you getting fired because the alarm app failed. Please
+
+* do some research if you have any concerns about features included in this script
+
+* before flashing it! YOU are choosing to make these modifications, and if
+
+* you point the finger at me for messing up your device, I will laugh at you.
+```
+
+**✨ CREDITS:**<br>
+This tool is based on **Xiaomi Snapdragon Series Splash Logo Image Maker Tool** by **GokulNC**<br>
+Special Thanks to **GokulNC** & **Pzqqt** (for [Sources](https://forum.xda-developers.com/t/guide-how-to-change-boot-logo-splash-screen-for-snapdragon-devices-splash-img.3470473/#post-68896881))
+<br>
+<br>
+
+***
+An Open Sourced Project - Developed with ❤️ by **Subhamoy**