Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Unverified Commit ffb0be2a authored by Simon Chan's avatar Simon Chan
Browse files

chore: update README

parent 9dc96845
Loading
Loading
Loading
Loading
+23 −29
Original line number Diff line number Diff line
# 📱 Android Debug Bridge (ADB) for Web Browsers
# Tango

[![GitHub license](https://img.shields.io/github/license/yume-chan/ya-webadb)](https://github.com/yume-chan/ya-webadb/blob/main/LICENSE)

Manipulate Android devices from any (supported) web browsers, even from another Android device.
A library and application for browsers to interact with Android devices via ADB.

[🚀 Online Demo](https://yume-chan.github.io/ya-webadb)

## Compatibility

| Connection                            | Chromium-based Browsers        | Firefox   | Node.js                       |
| ------------------------------------- | ------------------------------------- | ------- | -------- |
| USB cable                             | Yes via [WebUSB]                      | No      | Possible |
| Wireless via [WebSocket] <sup>1</sup> | Yes                                   | Yes     | Possible |
| Wireless via TCP                      | Yes via [Direct Sockets] <sup>2</sup> | No      | Possible |
| ------------------------------------- | ------------------------------ | --------- | ----------------------------- |
| USB cable                             | Supported using [WebUSB] API   | No        | Supported using `usb` package |
| Wireless via [WebSocket] <sup>1</sup> | Supported                      | Supported | Possible using `ws` package   |
| Wireless via TCP                      | WIP using [Direct Sockets] API | No        | Possible using `net` module   |

[WebUSB]: https://wicg.github.io/webusb/
[WebSocket]: https://websockets.spec.whatwg.org/
[Direct Sockets]: https://wicg.github.io/direct-sockets/
[webusb]: https://wicg.github.io/webusb/
[websocket]: https://websockets.spec.whatwg.org/
[direct sockets]: https://wicg.github.io/direct-sockets/

<sup>1</sup> Requires WebSockify softwares, see [instruction](https://github.com/yume-chan/ya-webadb/discussions/245#discussioncomment-384030) for detail.

<sup>2</sup> Chrome for Android doesn't support Direct Sockets. Need extra steps to enable. See [#349](https://github.com/yume-chan/ya-webadb/issues/349) for detail.

## Security concerns

Accessing USB devices (especially your phone) directly from a web page can be **very dangerous**. Firefox developers even refused to implement the WebUSB standard because they [considered it to be **harmful**](https://mozilla.github.io/standards-positions/#webusb).

## Features

* 📁 File Management
  * 📋 List
  * ⬆ Upload
  * ⬇ Download
  * 🗑 Delete
* 📷 Screen Capture
* 📜 Interactiv Shell
* ⚙ Enable ADB over WiFi
* 📦 Install APK
* 🎥 [Scrcpy](https://github.com/Genymobile/scrcpy) compatible client (screen mirroring and controling device)
* 🔌 Power and reboot to different modes
-   📁 File Management
    -   📋 List
    -   ⬆ Upload
    -   ⬇ Download
    -   🗑 Delete
-   📷 Screen Capture
-   📜 Interactiv Shell
-   ⚙ Enable ADB over WiFi
-   📦 Install APK
-   🎥 [Scrcpy](https://github.com/Genymobile/scrcpy) compatible client (screen mirroring and controling device)
-   🔌 Power and reboot to different modes

[📋 Project Roadmap](https://github.com/yume-chan/ya-webadb/issues/348)

@@ -48,5 +42,5 @@ See [CONTRIBUTE.md](./CONTRIBUTE.md)

## Credits

* Google for [ADB](https://android.googlesource.com/platform/packages/modules/adb) ([Apache License 2.0](./adb.NOTICE))
* Romain Vimont for [Scrcpy](https://github.com/Genymobile/scrcpy) ([Apache License 2.0](https://github.com/Genymobile/scrcpy/blob/master/LICENSE))
-   Google for [ADB](https://android.googlesource.com/platform/packages/modules/adb) ([Apache License 2.0](./adb.NOTICE))
-   Romain Vimont for [Scrcpy](https://github.com/Genymobile/scrcpy) ([Apache License 2.0](https://github.com/Genymobile/scrcpy/blob/master/LICENSE))