diff --git a/README.md b/README.md index 75d7b69d..78a62e50 100644 --- a/README.md +++ b/README.md @@ -47,16 +47,14 @@ OVERVIEW: Search for iOS apps available on the App Store. USAGE: ipatool search [--limit ] [--country ] [--device-family ] [--log-level ] ARGUMENTS: - The term to search for. + The term to search for. OPTIONS: - -l, --limit The maximum amount of search results to retrieve. - (default: 5) - -c, --country The two-letter (ISO 3166-1 alpha-2) country code for - the iTunes Store. (default: US) + -l, --limit The maximum amount of search results to retrieve. (default: 5) + -c, --country The two-letter (ISO 3166-1 alpha-2) country code for the + iTunes Store. (default: US) -d, --device-family - The device family to limit the search query to. - (default: iPhone) + The device family to limit the search query to. (default: iPhone) --log-level The log level. (default: info) --version Show the version. -h, --help Show help information. @@ -67,21 +65,24 @@ To download a copy of the ipa file, use the `download` command. ``` OVERVIEW: Download (encrypted) iOS app packages from the App Store. -USAGE: ipatool download --bundle-identifier [--email ] [--password ] [--auth-code ] [--country ] [--device-family ] [--log-level ] +USAGE: ipatool download --bundle-identifier [--email ] [--password ] [--auth-code ] [--country ] [--device-family ] [--output ] [--log-level ] OPTIONS: -b, --bundle-identifier - The bundle identifier of the target iOS app. - -e, --email The email address for the Apple ID. + The bundle identifier of the target iOS app. + -e, --email The email address for the Apple ID. -p, --password - The password for the Apple ID. - --auth-code The 2FA code for the Apple ID. - -c, --country The two-letter (ISO 3166-1 alpha-2) country code for the iTunes Store. (default: US) + The password for the Apple ID. + --auth-code The 2FA code for the Apple ID. + -c, --country The two-letter (ISO 3166-1 alpha-2) + country code for the iTunes Store. (default: US) -d, --device-family The device family to limit the search query to. (default: iPhone) + -o, --output The destination path of the downloaded app package. --log-level The log level. (default: info) --version Show the version. -h, --help Show help information. + ``` **Note:** You can specify the Apple ID email address and username as arguments when using the tool or by setting them as environment variables (`IPATOOL_EMAIL` and `IPATOOL_PASSWORD`). If you do not specify this information using either of those methods, the tool will prompt for user input in an interactive session. Similarly, you can supply the 2FA code interactively or using the environment variable `IPATOOL_2FA_CODE`. diff --git a/demo.gif b/demo.gif index 7507b697..84190d6e 100644 Binary files a/demo.gif and b/demo.gif differ