Update README, add screenshot

nisargjhaveri · Jan 9, 2025 · 3cca040 · 3cca040
1 parent 45071e5
commit 3cca040
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# vscode-remote-adb
+# vscode-remote-adb · Remote Android Development in VS Code
+
+Use local Android devices or emulators for debugging when using [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview).
+
+![Screenshot showing Remote Android view for connecting local android devices](./images/screenshot.png)
+
+## Features
+- Connect and share locally connected Android devices directly from VS Code.
+- Share wireless or USB connected device including locally running Android Emulators.
+- Connected devices are available for debugging using any tools on the remote machine via `adb`.
+
+## Quick Start
+- Find the "Remote Android" view in Debug panel, when connected to remote host.
+- Choose a device and "Connect to Remote".
diff --git a/images/screenshot.png b/images/screenshot.png