Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update Readme.md with the details on customizing ADB location. 

Fixes: #21
  • Loading branch information
moozzyk authored Oct 6, 2020
1 parent 07ecd4c commit 87b6c73
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ or with
- ADB:📱 Disconnect from any devices (Disconnect ever device attached (equivalent `adb disconnect`))
- ADB:📱 Connect to device from List (Show an list from devices attached to connect (equivalent `adb devices`))
- ADB:📱 Pick .APK file and install (Install on current active device (Will prompt user on Android Screen))
- ADB:📱 Setup custom ADB location (Configure location of ADB)
- ADB:📱 Remove custom ADB location (Clear custom ADB location)
- ADB:🔥 Enable Firebase events debug mode (Run firebase events in debug mode)
- ADB:🔥 Disable Firebase events debug mode (Run firebase events in debug mode)
- ADB:⚠️ Kill ADB server (Kill ADB Server runing (equivalent `adb kill-server`))
Expand Down Expand Up @@ -78,6 +80,17 @@ Below you can see some GIFs demostrating use cases.

</div>

## ADB location resolution

By default the extension is looking for ADB in the following locations:
- Linux - `$HOME/Android/Sdk`
- MacOS - `$HOME/Library/Android/sdk/platform-tools`
- Windows - `%USERPROFILE%\AppData\Local\Android\Sdk\platform-tools` (if the `%USERPROFILE%` environment variable is not defined the path to the profile directory of the current user will be used as the starting point)

The extension will resolve the ADB location each time an ADB command is executed.

The ADB location can be customized using the `Setup custom ADB location` command. The custom ADB location can be cleared using the `Remove custom ADB location` command.

# Tests

All done with [Jest](https://jestjs.io/) you can read more about [here.](https://jestjs.io/docs/en/getting-started.html)
Expand Down

0 comments on commit 87b6c73

Please sign in to comment.