Skip to content

Commit 43ac64f

Browse files
committed
Update README.
1 parent f18865e commit 43ac64f

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1-
# Android Web Debugging Bridge
1+
# Android Web Debug Bridge
22

3-
This project aims to extend the accessibility of debugging with Android devices by exposing the functionality of the Android Debugging Bridge through a web API.
3+
AWDB is an HTTP API wrapping the [Android Debug Bridge utility](https://developer.android.com/studio/command-line/adb).
4+
5+
It aims to make it easier to use remote Android devices for testing and debugging. Developers and CI tools can interact with devices on remote hosts through a simple HTTP interface, without the need to configure SSH access and port-forwarding.
6+
7+
## Installation
8+
9+
AWDB can be installed by calling `go get github.com/rightmesh/awdb`. It requires ADB to be installed.
10+
11+
Once installed, run AWDB with `$GOPATH/bin/awdb`, or just `awdb` if `$GOBIN` is on your `$PATH`.
12+
13+
**Note:** AWDB does not have any built-in security or authentication. Ensure any servers running AWDB are behind a firewall and/or reverse proxy with sufficient security features to prevent unauthorized access to your devices.
14+
15+
TODO: Pre-compiled release binaries.
16+
17+
## API
18+
19+
AWDB's API is documented with the OpenAPI specification [here](api/openapi-spec/awdb.yml). You can browse the documentation online [here](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/RightMesh/awdb/api/openapi-spec/awdb.yml).

0 commit comments

Comments
 (0)