From 8cd780ac676b8060a76af827d8b18b0b295fcbca Mon Sep 17 00:00:00 2001
From: Martin Szulecki
Date: Sat, 13 Jun 2020 02:47:25 +0200
Subject: Improve README.md with feature, installation and usage sections

---
 README.md | 100 +++++++++++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 80 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 5ed83f3..379f615 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,99 @@
 # ideviceinstaller
 
-## About
+*A command-line application to manage apps and app archives on iOS devices.*
 
-The ideviceinstaller tool allows interacting with the installation_proxy service
-of an iOS device allowing to install, upgrade, uninstall, archive, restore
-and enumerate installed or archived apps.
+## Features
 
-It makes use of the fabulous libimobiledevice library that allows communication
-with iOS devices.
+The ideviceinstaller application allows interacting with the app installation
+service of an iOS device.
 
-## Requirements
+It makes use of the fabulous [libimobiledevice library](https://github.com/libimobiledevice/libimobiledevice) that allows
+communication with iOS devices.
 
-Development Packages of:
-* libimobiledevice
-* libplist
-* libzip
+Some key features are:
 
-## Installation
+- **Status:** Install, upgrade, uninstall, archive, restore and enumerate apps
+- **Browse**: Allows to retrieve a list of installed apps with filter options
+- **Install**: Supports app package, carrier bundle and developer .app directory
+- **Format**: Allows command output in plist format
+- **Compatibility**: Supports latest device firmware releases
+- **Cross-Platform:** Tested on Linux, macOS, Windows and Android platforms
 
-To compile run:
-```bash
+## Installation / Getting started
+
+### Debian / Ubuntu Linux
+
+First install all required dependencies and build tools:
+```shell
+sudo apt-get install \
+	build-essential \
+	checkinstall \
+	git \
+	autoconf \
+	automake \
+	libtool-bin \
+	libplist-dev \
+	libimobiledevice-dev \
+	libzip-dev \
+	usbmuxd
+```
+
+Continue with cloning the actual project repository:
+```shell
+git clone https://github.com/libimobiledevice/ideviceinstaller.git
+cd ideviceinstaller
+```
+
+Now you can build and install it:
+```shell
 ./autogen.sh
 make
 sudo make install
 ```
 
-## Who/What/Where?
+## Usage
+
+First of all attach your device to your machine.
+
+Then simply run:
+```shell
+idevicerestore --list-apps
+```
+
+This will print a list of `<appid>` identifiers (bundle identifiers) for use
+with other commands (see further below).
 
-* Home: https://libimobiledevice.org/
-* Code: `git clone https://git.libimobiledevice.org/ideviceinstaller.git`
-* Code (Mirror): `git clone https://github.com/libimobiledevice/ideviceinstaller.git`
-* Tickets: https://github.com/libimobiledevice/ideviceinstaller/issues
+To install an app from a package file use:
+```shell
+idevicerestore --install <file>
+```
+
+To uninstall an app with the `<appid>` from the device use:
+```shell
+idevicerestore --uninstall <appid>
+```
+
+Please consult the usage information or manual page for a full documentation of
+available command line options:
+```shell
+ideviceinstaller --help
+man ideviceinstaller
+```
+
+## Links
+
+* Homepage: https://libimobiledevice.org/
+* Repository: https://git.libimobiledevice.org/ideviceinstaller.git
+* Repository (Mirror): https://github.com/libimobiledevice/ideviceinstaller.git
+* Issue Tracker: https://github.com/libimobiledevice/ideviceinstaller/issues
 * Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
 * Twitter: https://twitter.com/libimobiledev
 
+## License
+
+This software is licensed under the [GNU General Public License v2.0](https://www.gnu.org/licenses/gpl-2.0.en.html),
+also included in the repository in the `COPYING` file.
+
 ## Credits
 
 Apple, iPhone, iPod, iPad, Apple TV and iPod Touch are trademarks of Apple Inc.
@@ -41,4 +101,4 @@ Apple, iPhone, iPod, iPad, Apple TV and iPod Touch are trademarks of Apple Inc.
 ideviceinstaller is an independent software application and has not been
 authorized, sponsored or otherwise approved by Apple Inc.
 
-README Updated on: 2020-06-08
+README Updated on: 2020-06-13
-- 
cgit v1.1-32-gdbae