Documentation changes and Logo

Author: 128keaton

.gitignore

@@ -2,3 +2,4 @@
 nor-backups/nor-*
 SecureROM-*
 n88ap-iBSS-4.3.5.img3
+*.ipsw

README.md

@@ -1,57 +1,47 @@
-# ipwndfu: open-source jailbreaking tool for older iOS devices
+![](repo/ipwndfu.png)
+*Open-source jailbreaking tool for older iOS devices*
 
-### Beta software
 
-Backup your data. 
+**Please read the [disclaimer](#Disclaimer) before using**
 
-This tool is currently in beta and could potentially brick your device. It will attempt to save a copy of data in NOR to nor-backups folder before flashing new data to NOR, and it will attempt to not overwrite critical data in NOR which your device requires to function. If something goes wrong, hopefully you will be able to restore to latest IPSW in iTunes and bring your device back to life, or use nor-backups to restore NOR to the original state, but I cannot provide any guarantees.
-
-### No warranty
-
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-### Credit
-
-geohot for limera1n exploit
+## Features
 
+* Jailbreak iPhone 3GS (new bootrom) with alloc8 untethered bootrom exploit. :-)
 
-### Dependencies
+* Pwned DFU Mode exploit for S5L8920 devices using limera1n exploit, and compatible with Yosemite, El Capitan, and Sierra.
 
-This tool should be compatible with Mac and Linux, and it was mostly tested on Yosemite and Sierra. It probably won't work in a virtual machine.
+* Dump SecureROM on S5L8920 devices.
 
-* libusb
+* Dump NOR on S5L8920 devices.
 
-On a Mac, you can install libusb using brew:
+* Flash NOR on S5L8920 devices.
 
-```
-brew install libusb
-```
+* Encrypt or decrypt hex data on a connected device in pwned DFU Mode using its GID or UID key.
 
-* pyusb
 
-On a Mac, you can install pyusb using pip:
-```
-pip install pyusb
-```
+## Dependencies
 
-On a Mac, if you do not have pip installed, follow instructions from the official site and install it with get-pip.py: https://pip.pypa.io/en/stable/installing/
+This tool should be compatible with Mac and Linux, and it was mostly tested on Yosemite and Sierra. It probably won't work in a virtual machine.
 
-* iPhone 3GS iOS 4.3.5 iBSS
+* libusb, `brew install libusb`
+* pyusb, `pip install pyusb`
+* [pip](https://pip.pypa.io/en/stable/installing/)
+* [iPhone 3GS iOS 4.3.5 iBSS](#iBSS)
 
 Download iPhone 3GS iOS 4.3.5 IPSW using a link found on https://ipsw.me/ and extract iBSS using the following command, then move the file to ipwndfu folder:
 
 ```
 unzip -p iPhone2,1_4.3.5_8L1_Restore.ipsw Firmware/dfu/iBSS.n88ap.RELEASE.dfu > n88ap-iBSS-4.3.5.img3
 ```
 
-### Patch for libusb required to make limera1n work on El Capitan and Sierra
+## libusb Patch:
+**Only applicable on El Capitan and Sierra**
 
-Reason:
+[Source](https://www.belle-aurore.com/mike/2016/06/os-x-el-capitan-and-its-refusal-to-reset-usb-devices/)
 
-https://www.belle-aurore.com/mike/2016/06/os-x-el-capitan-and-its-refusal-to-reset-usb-devices/
+You should have libusb installed using brew. Make sure you are using 1.0.21 (latest version as of writing).
 
-You should have libusb installed using brew. 1.0.21 is the latest version. Calculate the SHA1 hash:
+Calculate the SHA1 hash:
 
 ```
 openssl sha1 /usr/local/Cellar/libusb/1.0.21/lib/libusb-1.0.0.dylib
@@ -70,36 +60,28 @@ sudo bspatch /usr/local/Cellar/libusb/1.0.21/lib/libusb-1.0.0.dylib /usr/local/C
 ```
 
 
-### Features
-
-* Jailbreak iPhone 3GS (new bootrom) with alloc8 untethered bootrom exploit. :-)
 
-* Pwned DFU Mode exploit for S5L8920 devices using limera1n exploit, and compatible with Yosemite, El Capitan, and Sierra.
 
-* Dump SecureROM on S5L8920 devices.
+## Tutorial
 
-* Dump NOR on S5L8920 devices.
-
-* Flash NOR on S5L8920 devices.
-
-* Encrypt or decrypt hex data on a connected device in pwned DFU Mode using its GID or UID key.
-
-
-### Installing alloc8 on iPhone 3GS (new bootrom)
-
-* This tool can be used to downgrade or jailbreak iPhone 3GS (new bootrom) without SHSH blobs:
+This tool can be used to downgrade or jailbreak iPhone 3GS (new bootrom) without SHSH blobs:
 
 https://github.com/axi0mX/ipwndfu/blob/master/JAILBREAK-GUIDE.md
 
+## Official Write up
+
+The official write up for the alloc8 exploit can be found [here](https://github.com/axi0mX/alloc8)
 
-### How does alloc8 work?
+## iBSS
 
-* Write-up:
+Download iPhone 3GS iOS 4.3.5 IPSW using a link found on https://ipsw.me/ and extract iBSS using the following command, then move the file to ipwndfu folder:
 
-https://github.com/axi0mX/alloc8
+```
+unzip -p iPhone2,1_4.3.5_8L1_Restore.ipsw Firmware/dfu/iBSS.n88ap.RELEASE.dfu > n88ap-iBSS-4.3.5.img3
+```
 
 
-### Coming soon
+## Coming soon
 
 * Reorganize and refactor code and fix issues with tabs/spaces.
 
@@ -112,3 +94,20 @@ https://github.com/axi0mX/alloc8
 * Install custom boot logos on devices jailbroken with 24Kpwn and alloc8.
 
 * Enable verbose boot on devices jailbroken with 24Kpwn and alloc8.
+
+## Disclaimer
+
+**Warning: This is BETA software**
+
+Backup your data.
+
+This tool is currently in beta and could potentially brick your device. It will attempt to save a copy of data in NOR to nor-backups folder before flashing new data to NOR, and it will attempt to not overwrite critical data in NOR which your device requires to function. If something goes wrong, hopefully you will be able to restore to latest IPSW in iTunes and bring your device back to life, or use nor-backups to restore NOR to the original state, but I cannot provide any guarantees.
+
+**There is NO warranty provided**
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+## Credit
+
+*geohot for limera1n exploit*