Create README.md

README.md

@@ -0,0 +1,47 @@
+# AutoRepack
+This script is designed to make custom ROM flashings easier on the user. Note that this is **for Poco F3 device.**
+Many recoveries still can't flash these ROMs and this tool allows you to convert them into TWRP friendly flashables.
+
+It can also repack fastboot ROMS into recovery flashables so that user wouldn't need PC to handle these trivial stuff.
+
+![TUI Menu](https://i.ibb.co/tH5VH1X/Screenshot-20220123-221636-Termux.png)
+
+As seen in the photo, there are certain options given to the user,
+such as decryption patch, recovery and magisk (roots system) selections.
+These are within users free will and are **not forced** upon unlike some other works out there.
+
+![Custom recovery selection](https://i.ibb.co/zRHbNgG/Screenshot-20220123-221421-Termux.png)
+
+Custom recovery selection menu comes after TUI menu is okayed. In this menu, you can download, import
+or remove recoveries and use them in your repack ROM.
+
+![Resuming where you left of](https://i.ibb.co/k3KSZsk/Screenshot-20220123-221249-Termux.png)
+
+In case you quit the program in the middle of conversion and you want to continue where you left of,
+Integrity Check is implemented to catch that situation and put you right back on track.
+
+![Integrity check for missing files](https://i.ibb.co/pLTHtkV/Screenshot-20220123-221311-Termux.png)
+![ROM Conversion](https://i.ibb.co/Rpmq2Rd/Screenshot-20220123-221617-Termux.png)
+
+Integrity Check also checks the workspace so that there's no residual files that might hinder the program.
+
+# Features:
+
+- User Interface
+- Fastboot-recovery conversion
+- Compression to lessen repack size (auto detected if not given value)
+- Flashable zip splitting to bypass 4G limit in recoveries.
+- Granting partitions read-write access
+- Can re-repack already repacked ROMs.
+- Custom recovery options
+- Custom magisk options
+- Firmware selection
+- Option to enable/disable encryption, magisk and recovery
+- Remote updating, listing new and past updates, update reversing.
+
+and many more..
+
+This script is only usable in Android phones and installation file is
+in our Telegram chat:
+
+https://t.me/PocoF3DFE