commit c3098771c234d0ccb1451f4199d9bc60781691f5
Author: vexdevt <vexdevt@noreply.legendsgit>
Date:   Sat May 11 15:17:52 2024 -0500

    add readme

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6d40a71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# bnyx
+a boot image extraction utility, simple enough ( you dont probably need this if you are a eagler developer. ).
+bnyx can do basic stuff like :
+- print out cmdline
+- extract kernel, ramdisk
+- print out kernel load adress
+- print out ramdisk load addr
+etc..
+
+# how to extract your boot image?
+Boot to recovery ( twrp, orangefox whatever ), Open terminal in the recovery and run the command :
+```dd if=/dev/block/bootdevice/by-name/boot of=/sdcard/boot.img```
+<br> for zone optional double a/b partition devices :
+```dd if=/dev/block/bootdevice/by-name/boot_a of=/sdcard/boot.img```
+# how to use the damn program?
+drop your boot image to bnyx and it will extract the contents inside automatically for you <br>
+if you just want the cmdline or ramdisk, kernel etc... you can specify the arguments.
+```
+--boot-args
+--ramdisk
+--kernel
+--pagesize
+--kernel-load-addr
+--ramdisk-load-addr
+```
+
+# acknowledgments
+https://android.googlesource.com/platform/system/tools/mkbootimg/+/refs/heads/main/include/bootimg/bootimg.h <br>
+https://github.com/anestisb/android-unpackbootimg/blob/master/mkbootimg.py <br>
+https://github.com/csimmonds/boot-extract <br>
\ No newline at end of file