Merge branch 'chore/update_readme'

README.md

@@ -1,29 +1,29 @@
 # AAB Installer
 
-This is a set of processes that allows to install an AAB into a device or emulator using adb and bundle-tool. If running on a macOS device with Homebrew, this process will attempt to install bundle-tool if it is not already installed.
+This is a set of processes that allows the installation of an AAB bundle into a device or emulator using adb and bundle-tool. If running on a macOS device with Homebrew, this process will attempt to install bundle-tool if it is not already installed.
 
 ## Installation
 
 install-aab is available as a Homebrew Formula. To install it:
 
 ```sh
-$ brew tap igorcferreira/tap
-$ brew install install-aab
+brew tap igorcferreira/tap
+brew install install-aab
 ```
 
 ## Usage
 
-#### Simple usage (debug keystore):
+### Simple usage (debug keystore)
 
-To install an AAB into the connected device, signing the generated APK with the device debug keystore, just run:
+To install an AAB into the connected device, using the debug keystore to sign the generated APK, just run:
 
 ```sh
 ./install-aab --bundle my-app.aab
 ```
 
-#### Signed APK usage:
+### Signed APK usage
 
-If you need to sign the generate APK with a specific keystore, please use the extended configuration:
+If you need to sign the generated APK with a specific keystore, please use the extended configuration:
 
 ```sh
 ./install-aab --bundle ~/Downloads/app-fw-release.aab \
@@ -33,17 +33,18 @@ If you need to sign the generate APK with a specific keystore, please use the ex
 --alias-password android
 ```
 
-### Multiple devices connected:
+### Multiple devices connected
 
-If you have multiple devices connected to the machine, please specify the device id with the parameter `--device-id`. If the device id is not set, the install will fail.
+If you have multiple devices connected to the machine, please specify the device ID with the parameter `--device-id`. If the device ID is not set, the installation will fail.
 
 ```sh
 ./install-aab --bundle my-app.aab --device-id emulator-5554
 ```
 
 ### Full help text
 
-```
+```sh
+$ ./install-aab --help
 Usage:
 install-aab -b /path/to/app.aab
 
@@ -55,6 +56,7 @@ Parameters:
     --alias-password -ap: Alias password (optional)
     --help           -h : Prints this helper message
     --device-id         : Id of the device where the APK will be installed (optional)
+    --local-testing     : Pass forward the --local-testing flag to bundletool while building the apks (optional)
 
 Keystore:
     If all the key configuration is passed, the provided keystore will be used to sign the application. Otherwise, debug keystore is used.
@@ -69,4 +71,4 @@ Keystore:
 
 ----
 
-This script is inspired on [JonnyBurger/install-aab](https://github.com/JonnyBurger/install-aab). This version was created to be able to run without NVM/Node in the machine and allow sign the generated APK.
+This script is inspired by [JonnyBurger/](https://github.com/JonnyBurger/install-aab)install-aab](https://github.com/JonnyBurger/install-aab). This version was created to be able to run without NVM/Node in the machine and allow signing the generated APK.