yetangitu/ya-webadb
1
0
Fork 0
mirror of https://github.com/yume-chan/ya-webadb.git synced 2025-10-03 01:39:21 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: update README

Browse source
This commit is contained in:
Simon Chan 2023-10-08 02:07:05 +08:00
parent 4bc58028b1
commit 599351c9b1
No known key found for this signature in database
GPG key ID: A8B69F750B9BCEDD
1 changed files with 25 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

67
README.md
View file

@ -1,49 +1,38 @@
# Tango
<p align="center">
<a href="https://app.tangoapp.dev">
<img alt="Tango" src="https://raw.githubusercontent.com/yume-chan/ya-webadb/main/.github/logo.svg" width="200">
</a>
</p>
[![MIT license](https://img.shields.io/github/license/yume-chan/ya-webadb)](https://github.com/yume-chan/ya-webadb/blob/main/LICENSE)
<h1 align="center">Tango</h1>
A library and a Web app that allow browsers to interact with Android devices via ADB (Android Debugging Protocol).
<p align="center">
ADB in your browser
</p>
All features work on Chrome for Android, use a C-to-C (or OTG) cable.
<p align="center">
<a href="https://github.com/yume-chan/ya-webadb/blob/main/LICENSE">
<img alt="MIT License" src="https://img.shields.io/github/license/yume-chan/ya-webadb">
</a>
<a href="https://github.com/yume-chan/ya-webadb/releases">
<img alt="GitHub release" src="https://img.shields.io/github/v/release/yume-chan/ya-webadb">
</a>
<a href="https://www.npmjs.com/package/@yume-chan/adb">
<img alt="npm" src="https://img.shields.io/npm/dm/%40yume-chan/adb?logo=npm">
</a>
</p>
[🚀 Web App](https://tango-web-mu.vercel.app/) | [Old Demo](https://tango-adb.github.io/old-demo/)
Tango is a TypeScript re-implementation of ADB (Android Debugging Bridge) client that works in Chromium-based browsers (including Chrome for Android), Node.js, and Electron.
## Working Modes
Try it out at https://app.tangoapp.dev
### Direct Connection Mode
## Documentation
In this mode, Google ADB is not required for this library to communicate with Android devices (in fact, Google ADB must not be running in order to use this mode).
This mode is suitable for running on end-users' devices where Google ADB is not installed, or on mobile devices where Google ADB is not available.
Before connecting, make sure to close Google ADB (Run `adb kill-server` in a terminal or close `adb.exe` from Task Manager) and all programs that may use ADB (e.g. Android Studio, Visual Studio, Godot Editor, etc.).
### Google ADB Client Mode
In this mode, this library talks to a Google ADB server, which is either running on the same machine or on a remote machine. This allows other ADB-based tools to work alongside this library.
## Compatibility
| Connection | Chromium-based Browsers | Node.js |
| -------------------------------- | -------------------------------- | ----------------------------- |
| Direct Connection over USB cable | Supported using [WebUSB] API | Supported using `usb` package |
| Direct Connection over TCP | Waiting for [Direct Sockets] API | Possible using `net` module |
| Google ADB client over TCP | Waiting for [Direct Sockets] API | Supported using `net` module |
[webusb]: https://wicg.github.io/webusb/
[direct sockets]: https://wicg.github.io/direct-sockets/
## API documentation
Currently the API is unstable and the documentation is lacking, but there are three sources you can refer to:
- Each package's `README.md` file
- The source code of old demo at https://github.com/tango-adb/old-demo (it's a React app)
- The work-in-progress documentation site at https://tango-adb.github.io/docs/adb/installation
Check the latest documentation at https://tango-adb.github.io/docs/
## Contribute
See [CONTRIBUTING.md](./CONTRIBUTING.md)
See [CONTRIBUTING.md](./CONTRIBUTING.md) for how to run and develop this project.
## Sponsors
@ -60,9 +49,3 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)
<a href="https://opencollective.com/ya-webadb/backer/8/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/8/avatar.svg?requireActive=false"></a>
<a href="https://opencollective.com/ya-webadb/backer/9/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/9/avatar.svg?requireActive=false"></a>
<a href="https://opencollective.com/ya-webadb/backer/10/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/10/avatar.svg?requireActive=false"></a>
## Used open-source projects
- [ADB](https://android.googlesource.com/platform/packages/modules/adb) from Google ([Apache License 2.0](./adb.NOTICE))
- [Scrcpy](https://github.com/Genymobile/scrcpy) from Romain Vimont ([Apache License 2.0](https://github.com/Genymobile/scrcpy/blob/master/LICENSE))
- [web-streams-polyfill](https://github.com/MattiasBuelens/web-streams-polyfill) from Mattias Buelens ([MIT License](https://github.com/MattiasBuelens/web-streams-polyfill/blob/master/LICENSE))