add changelog

This commit is contained in:
Simon Chan 2023-08-25 22:05:02 +08:00
parent dae4dcd6fe
commit 740086d27f
No known key found for this signature in database
GPG key ID: A8B69F750B9BCEDD
12 changed files with 83 additions and 10 deletions

View file

@ -2,21 +2,33 @@
[![MIT license](https://img.shields.io/github/license/yume-chan/ya-webadb)](https://github.com/yume-chan/ya-webadb/blob/main/LICENSE)
A library and application for browsers to interact with Android devices via ADB.
A library and a Web app that allow browsers to interact with Android devices via ADB (Android Debugging Protocol).
All features are working on Chrome for Android, use a C-to-C cable or run WebSockify in Termux to connect.
All features work on Chrome for Android, use a C-to-C (or OTG) cable or via WebSockify running in Termux (see [compatibility table](#compatibility) below).
[🚀 Online Demo](https://yume-chan.github.io/ya-webadb)
[🚀 Web App](https://tango-web-mu.vercel.app/) | [Old demo](https://yume-chan.github.io/ya-webadb)
For USB connection, 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.) before connecting.
## Working Modes
### Direct Connection Mode
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.
### 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 | Firefox | Node.js |
| ----------------------------------------- | ------------------------------ | --------- | ----------------------------- |
| USB cable | Supported using [WebUSB] API | No | Supported using `usb` package |
| Wireless through [WebSocket] <sup>1</sup> | Supported | Supported | Possible using `ws` package |
| Wireless through TCP | WIP using [Direct Sockets] API | No | Possible using `net` module |
| Wireless through TCP | Waiting for [Direct Sockets] API | No | Possible using `net` module |
[webusb]: https://wicg.github.io/webusb/
[websocket]: https://websockets.spec.whatwg.org/

View file

@ -32,7 +32,7 @@
},
"dependencies": {
"@yume-chan/adb": "workspace:^0.0.20",
"@yume-chan/adb-server-node-tcp": "workspace:^0.0.19",
"@yume-chan/adb-server-node-tcp": "workspace:^0.0.20",
"@yume-chan/android-bin": "workspace:^0.0.20",
"@yume-chan/stream-extra": "workspace:^0.0.20",
"commander": "^10.0.1",

View file

@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/adb-credential-web",
"comment": "Change to save private keys in IndexedDB, allow usage from Web Workers",
"type": "none"
}
],
"packageName": "@yume-chan/adb-credential-web"
}

View file

@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/adb",
"comment": "Add typed errors for `framebuffer` command when current app disables screen capture",
"type": "none"
}
],
"packageName": "@yume-chan/adb"
}

View file

@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/adb",
"comment": "Change `AdbDaemonTransport` class to automatically close the connection, unless the new `preserveConnection` option is `true`",
"type": "none"
}
],
"packageName": "@yume-chan/adb"
}

View file

@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/adb",
"comment": "Add `recursive` and `force` options to `rm` method, allow deleting folders",
"type": "none"
}
],
"packageName": "@yume-chan/adb"
}

View file

@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/android-bin",
"comment": "Add support to stop `bugreport`",
"type": "none"
}
],
"packageName": "@yume-chan/android-bin"
}

View file

@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/android-bin",
"comment": "Merge `bugreport` and `bugreportz` wrappers, providing an `automatic` method to choose the best available bugreport method",
"type": "none"
}
],
"packageName": "@yume-chan/android-bin"
}

View file

@ -14,7 +14,7 @@ importers:
specifier: workspace:^0.0.20
version: link:../../libraries/adb
'@yume-chan/adb-server-node-tcp':
specifier: workspace:^0.0.19
specifier: workspace:^0.0.20
version: link:../../libraries/adb-server-node-tcp
'@yume-chan/android-bin':
specifier: workspace:^0.0.20

View file

@ -1,5 +1,5 @@
// DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
{
"pnpmShrinkwrapHash": "a5141c6066b3d19a36bfe08201796dd2828a4130",
"pnpmShrinkwrapHash": "8baf2e2e007bb49d5230ce1eded20db5d82dd1ff",
"preferredVersionsHash": "bf21a9e8fbc5a3846fb05b4fa0859e0917b2202f"
}

View file

@ -1,7 +1,6 @@
{
"name": "@yume-chan/adb-server-node-tcp",
"private": true,
"version": "0.0.19",
"version": "0.0.20",
"description": "ADB server connection for `@yume-chan/adb` using Node.js' `net` module",
"keywords": [
"adb",

View file

@ -503,7 +503,9 @@
},
{
"packageName": "@yume-chan/adb-server-node-tcp",
"projectFolder": "libraries/adb-server-node-tcp"
"projectFolder": "libraries/adb-server-node-tcp",
"shouldPublish": true,
"versionPolicyName": "adb"
},
{
"packageName": "@yume-chan/adb-cli",