Skip to content

Commit dcc0d07

Browse files
committed
docs readme: update infomations
Signed-off-by: John Sanpe <sanpeqf@gmail.com>
1 parent 6cf55da commit dcc0d07

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111
## Features
1212

1313
- [x] Daemon mode
14-
- [x] Support USB hot plugging
14+
- [x] Automatic timeout close for unresponsive services
15+
- [x] Cross endianness (Big-Endian / Little-Endian)
16+
- [x] USB hot plugging
1517
- [x] Shell command
1618
- [x] Reboot command
1719
- [x] Remount command
@@ -27,19 +29,49 @@ $ adb push local-path remote-path # push files to device
2729
$ adb pull remote-path local-path # pull files from device
2830
```
2931

30-
## Benchmark Test
32+
## Benchmark test
3133

32-
sdbd speed:
34+
SDBD speed:
3335

3436
![sdbd-speed](./docs/sdbd-speed.png)
3537

36-
adbd speed:
38+
ADBD speed:
3739

3840
![adbd-speed](./docs/adbd-speed.png)
3941

4042
**SDBD is five times the speed of ADBD.**
4143

42-
## Reference Link
44+
## How to use
45+
46+
Usage:
47+
48+
```shell
49+
$ sdbd --help
50+
Usage: ./sdbd [option] ...
51+
Simple Debug Bridge Daemon (SDBD) v0.1
52+
53+
Options:
54+
-h, --help Display this information.
55+
-v, --version Display version information.
56+
-d, --daemon Run in daemon mode.
57+
-l, --loglevel=LEVEL Set print log level threshold.
58+
-t, --timout=SECONDS Set service idle timeout value.
59+
60+
The following optionals are for loglevel:
61+
0: Emerg (System is unusable)
62+
1: Alert (Action must be taken immediately)
63+
2: Crit (Critical conditions)
64+
3: Error (Error conditions)
65+
4: Warning (Warning conditions)
66+
5: Notice (Normal but significant condition)
67+
6: Info (Informational)
68+
7: Debug (Debug-level messages)
69+
70+
For bug reporting, please visit:
71+
<https://github.com/openbfdev/sdbd>
72+
```
73+
74+
## Reference link
4375

4476
- [xdbd](https://github.com/openbfdev/xdbd): https://github.com/openbfdev/xdbd
4577
- [adbd](https://github.com/BigfootACA/adbd): https://github.com/BigfootACA/adbd

0 commit comments

Comments
 (0)