From f4304f1f9d16adcebe27dfafcba1a52184a873e4 Mon Sep 17 00:00:00 2001
From: Priyansh Prajapati <88396544+itsspriyansh@users.noreply.github.com>
Date: Tue, 3 Sep 2024 23:35:44 +0530
Subject: [PATCH] doc: subcommand usage workflows (#69)

Co-authored-by: Priyansh Garg <priyanshgarg30@gmail.com>
---
 docs/subcommands/connect.md   | 15 +++++++++++++++
 docs/subcommands/install.md   | 32 ++++++++++++++++++++++++++++++++
 docs/subcommands/list.md      | 23 +++++++++++++++++++++++
 docs/subcommands/uninstall.md | 15 +++++++++++++++
 4 files changed, 85 insertions(+)
 create mode 100644 docs/subcommands/connect.md
 create mode 100644 docs/subcommands/install.md
 create mode 100644 docs/subcommands/list.md
 create mode 100644 docs/subcommands/uninstall.md

diff --git a/docs/subcommands/connect.md b/docs/subcommands/connect.md
new file mode 100644
index 0000000..10ebab7
--- /dev/null
+++ b/docs/subcommands/connect.md
@@ -0,0 +1,15 @@
+## Workflows of the `connect` subcommand
+
+**Syntax**
+```sh
+npx @nightwatch/mobile-helper android connect FLAG [configs]
+```
+
+### 1. Connect a real device wirelessly
+
+> Note: Only devices with Android version 11 or higher are supported.
+
+Run the below command to connect to a real device wirelessly:
+```sh
+npx @nightwatch/mobile-helper android connect --wireless
+```
diff --git a/docs/subcommands/install.md b/docs/subcommands/install.md
new file mode 100644
index 0000000..a219281
--- /dev/null
+++ b/docs/subcommands/install.md
@@ -0,0 +1,32 @@
+## Workflows of the `install` subcommand
+
+**Syntax**
+```sh
+npx @nightwatch/mobile-helper android install FLAG [configs]
+```
+
+### 1. Install an APK
+
+Run the below command to install an APK on a real device or an AVD:
+
+```sh
+npx @nightwatch/mobile-helper android install --app
+
+# with configs
+npx @nightwatch/mobile-helper android install --app [--deviceId <device_id>] [--path <path_to_apk>]
+```
+
+**Configs**
+
+| Config                         | Description                                                    |
+| ------------------------------ | -------------------------------------------------------------- |
+| --deviceId \| -s <device_id>   | Id of the device to install the APK to                         |
+| --path \| -p <path_to_apk>     | Path to the APK file relative to the current working directory |
+
+### 2. Create a new Android Virtual Device
+
+Run the below command to create a new AVD:
+
+```sh
+npx @nightwatch/mobile-helper android install --avd
+```
diff --git a/docs/subcommands/list.md b/docs/subcommands/list.md
new file mode 100644
index 0000000..0bc4edd
--- /dev/null
+++ b/docs/subcommands/list.md
@@ -0,0 +1,23 @@
+## Workflows of the `list` subcommand
+
+**Syntax**
+
+```sh
+npx @nightwatch/mobile-helper android list [flags]
+```
+
+### 1. Show a list of connected devices
+
+Run the below command to show a list of all the connected real devices and running AVDs:
+
+```sh
+npx @nightwatch/mobile-helper android list --device 
+```
+
+### 2. Show a list of installed AVDs
+
+Run the below command to show a list of all the currently installed AVDs
+
+```sh
+npx @nightwatch/mobile-helper android list --avd
+```
diff --git a/docs/subcommands/uninstall.md b/docs/subcommands/uninstall.md
new file mode 100644
index 0000000..d3a390c
--- /dev/null
+++ b/docs/subcommands/uninstall.md
@@ -0,0 +1,15 @@
+## Workflows of the `uninstall` subcommand
+
+**Syntax**
+
+```sh
+npx @nightwatch/mobile-helper android uninstall FLAG [configs]
+```
+
+### 1. Delete an Android Virtual Device (AVD)
+
+Run the below command to delete an AVD:
+
+```sh
+npx @nightwatch/mobile-helper android uninstall --avd
+```