Skip to content

Commit 5bd2d96

Browse files
DCodeBotdector
andcommitted
docs: add structure diagram
Co-authored-by: D <code@dector.space>
1 parent defc86b commit 5bd2d96

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ applications, with an experimental CLI wrapper for supported workflows.
1414
## Contents
1515

1616
- [Install](#install)
17+
- [Overview](#overview)
1718
- [High-level client API](#high-level-client-api)
1819
- [Linux USB support](#linux-usb-support)
1920
- [Authentication helpers](#authentication-helpers)
@@ -38,6 +39,30 @@ The current TCP and Linux USB implementation uses only the Go standard library:
3839
no Android SDK, platform-tools, official `adb` binary, cgo, libusb, or native
3940
dependencies are required.
4041

42+
## Overview
43+
44+
adb-go is layered from low-level ADB protocol primitives up to high-level
45+
library workflows, with the CLI and daemon built on top.
46+
47+
```mermaid
48+
block-beta
49+
columns 2
50+
51+
cli["CMD/ADB-GO<br/>(experimental CLI)"]
52+
daemon["CMD/ADB-GOD<br/>(daemon foundation)"]
53+
54+
root["GITHUB.COM/DECTOR/ADB-GO<br/>(stable high-level API)"]:2
55+
56+
workflows["CLIENT WORKFLOWS<br/>(shell · push/pull · install · logcat · screencap · reboot · forward)"]:2
57+
58+
client["CLIENT<br/>(connections, services, device operations)"]:2
59+
60+
auth["AUTH<br/>(RSA key loading and signing)"]
61+
transports["TRANSPORTS<br/>(TCP · Linux USB)"]
62+
63+
protocol["PROTOCOL<br/>(ADB packets · handshake · streams)"]:2
64+
```
65+
4166
## High-level client API
4267

4368
Use the root package for the stable high-level API. It re-exports the `client`

0 commit comments

Comments
 (0)