summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 16 insertions, 0 deletions
diff --git a/README b/README
index e69de29..2f7b971 100644
--- a/README
+++ b/README
@@ -0,0 +1,16 @@
+== What is iRecovery? ==
+
+iRecovery is a libusb-based commandline utility for Mac OS X, Windows, and Linux. It is able to talk to iBoot/iBSS in Apple's iPhone/iPod touch via USB.
+
+It's completely open-source, the source code is released under the terms of the GNU General Public License v3.
+The full license text can be found in the LICENSE file.
+
+== Usage ==
+
+ ./iRecovery -s starts a shell.
+ ./iRecovery -r usb reset.
+ ./iRecovery -f <file> uploads a file.
+ ./iRecovery -c "command" send a single command.
+ ./iRecovery -l <file> sends a set of commands from a file (one per line).
+ ./Irecovery -x <file> uploads a file then resets the usb connection.
+