summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Martin Szulecki2020-06-13 02:47:25 +0200
committerGravatar Martin Szulecki2020-06-13 02:47:25 +0200
commit8cd780ac676b8060a76af827d8b18b0b295fcbca (patch)
treef27d6e25d7a71f68559b9c2bb6b52f8ec29d0ae5
parent6cd36e65435c63bf2569d825e1f42c83721b364a (diff)
downloadideviceinstaller-8cd780ac676b8060a76af827d8b18b0b295fcbca.tar.gz
ideviceinstaller-8cd780ac676b8060a76af827d8b18b0b295fcbca.tar.bz2
Improve README.md with feature, installation and usage sections
-rw-r--r--README.md100
1 files 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 @@
1# ideviceinstaller 1# ideviceinstaller
2 2
3## About 3*A command-line application to manage apps and app archives on iOS devices.*
4 4
5The ideviceinstaller tool allows interacting with the installation_proxy service 5## Features
6of an iOS device allowing to install, upgrade, uninstall, archive, restore
7and enumerate installed or archived apps.
8 6
9It makes use of the fabulous libimobiledevice library that allows communication 7The ideviceinstaller application allows interacting with the app installation
10with iOS devices. 8service of an iOS device.
11 9
12## Requirements 10It makes use of the fabulous [libimobiledevice library](https://github.com/libimobiledevice/libimobiledevice) that allows
11communication with iOS devices.
13 12
14Development Packages of: 13Some key features are:
15* libimobiledevice
16* libplist
17* libzip
18 14
19## Installation 15- **Status:** Install, upgrade, uninstall, archive, restore and enumerate apps
16- **Browse**: Allows to retrieve a list of installed apps with filter options
17- **Install**: Supports app package, carrier bundle and developer .app directory
18- **Format**: Allows command output in plist format
19- **Compatibility**: Supports latest device firmware releases
20- **Cross-Platform:** Tested on Linux, macOS, Windows and Android platforms
20 21
21To compile run: 22## Installation / Getting started
22```bash 23
24### Debian / Ubuntu Linux
25
26First install all required dependencies and build tools:
27```shell
28sudo apt-get install \
29 build-essential \
30 checkinstall \
31 git \
32 autoconf \
33 automake \
34 libtool-bin \
35 libplist-dev \
36 libimobiledevice-dev \
37 libzip-dev \
38 usbmuxd
39```
40
41Continue with cloning the actual project repository:
42```shell
43git clone https://github.com/libimobiledevice/ideviceinstaller.git
44cd ideviceinstaller
45```
46
47Now you can build and install it:
48```shell
23./autogen.sh 49./autogen.sh
24make 50make
25sudo make install 51sudo make install
26``` 52```
27 53
28## Who/What/Where? 54## Usage
55
56First of all attach your device to your machine.
57
58Then simply run:
59```shell
60idevicerestore --list-apps
61```
62
63This will print a list of `<appid>` identifiers (bundle identifiers) for use
64with other commands (see further below).
29 65
30* Home: https://libimobiledevice.org/ 66To install an app from a package file use:
31* Code: `git clone https://git.libimobiledevice.org/ideviceinstaller.git` 67```shell
32* Code (Mirror): `git clone https://github.com/libimobiledevice/ideviceinstaller.git` 68idevicerestore --install <file>
33* Tickets: https://github.com/libimobiledevice/ideviceinstaller/issues 69```
70
71To uninstall an app with the `<appid>` from the device use:
72```shell
73idevicerestore --uninstall <appid>
74```
75
76Please consult the usage information or manual page for a full documentation of
77available command line options:
78```shell
79ideviceinstaller --help
80man ideviceinstaller
81```
82
83## Links
84
85* Homepage: https://libimobiledevice.org/
86* Repository: https://git.libimobiledevice.org/ideviceinstaller.git
87* Repository (Mirror): https://github.com/libimobiledevice/ideviceinstaller.git
88* Issue Tracker: https://github.com/libimobiledevice/ideviceinstaller/issues
34* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel 89* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
35* Twitter: https://twitter.com/libimobiledev 90* Twitter: https://twitter.com/libimobiledev
36 91
92## License
93
94This software is licensed under the [GNU General Public License v2.0](https://www.gnu.org/licenses/gpl-2.0.en.html),
95also included in the repository in the `COPYING` file.
96
37## Credits 97## Credits
38 98
39Apple, iPhone, iPod, iPad, Apple TV and iPod Touch are trademarks of Apple Inc. 99Apple, 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.
41ideviceinstaller is an independent software application and has not been 101ideviceinstaller is an independent software application and has not been
42authorized, sponsored or otherwise approved by Apple Inc. 102authorized, sponsored or otherwise approved by Apple Inc.
43 103
44README Updated on: 2020-06-08 104README Updated on: 2020-06-13