From e47b917e795cd0b6c7cede5dd56f0186d117e24d Mon Sep 17 00:00:00 2001
From: Martin Szulecki
Date: Tue, 6 Oct 2015 21:30:56 +0200
Subject: Update README with git URL, IRC, twitter and common style

---
 README | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 60 insertions(+), 13 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 3c0c8a6..58f79a0 100644
--- a/README
+++ b/README
@@ -1,4 +1,5 @@
-== What is libirecovery? ==
+About
+=====
 
 libirecovery is a cross-platform library which implements communication to
 iBoot/iBSS found on Apple's iOS devices via USB. A command-line utility is also
@@ -7,17 +8,63 @@ provided.
 The software is completely open-source, the source code is released under the
 terms of the LGPL 2.1. The full license text can be found in the LICENSE file.
 
-Here's its usage:
+This is a fork of an older version from http://www.openjailbreak.org/ and is
+ment to be used with idevicerestore from the libimobiledevice project.
 
-irecovery [args]
-	-v		Start irecovery in verbose mode.
-	-c <cmd>	Send command to client.
-	-f <file>	Send file to client.
-	-k [payload]	Send usb exploit to client.
-	-h		Show this help.
-	-r		Reset client.
-	-s		Start interactive shell.
-	-e <script>	Executes recovery shell script.
+Requirements
+============
 
-You can get info on the shell commands here:
-http://code.google.com/p/chronicdev/wiki/iBootCommands
+Development Packages of:
+	libusb
+	libreadline
+
+Software:
+	make
+	autoheader
+	automake
+	autoconf
+	libtool
+	pkg-config
+	gcc
+
+Installation
+============
+
+To compile run:
+	./autogen.sh
+	make
+	sudo make install
+
+Who/What/Where?
+===============
+
+Home:
+	http://www.libimobiledevice.org/
+
+Code:
+	git clone http://git.libimobiledevice.org/libirecovery.git
+
+Code (Mirror):
+	git clone https://github.com/libimobiledevice/libirecovery.git
+
+Tickets:
+	http://github.com/libimobiledevice/libirecovery/issues
+
+Mailing List:
+	http://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
+
+IRC:
+	irc://irc.freenode.net#libimobiledevice
+
+Twitter:
+	https://twitter.com/libimobiledev
+
+Credits
+=======
+
+Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc.
+libirecovery is an independent software library and has not been authorized,
+sponsored, or otherwise approved by Apple Inc.
+
+README Updated on:
+	2015-10-06
-- 
cgit v1.1-32-gdbae