Skip to content

Commit df89eea

Browse files
committed
doc: update readme and version
1 parent 91fd22b commit df89eea

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# CLI for Badgerd SDWire Devices
2+
3+
Application also supports legacy SDWireC and non-Badger'd sdwires as well as
4+
new Badgerd SDwire Gen2 devices.
5+
6+
Please see below for usage:
7+
8+
```
9+
❯ sdwire --help
10+
Usage: sdwire [OPTIONS] COMMAND [ARGS]...
11+
12+
Options:
13+
--help Show this message and exit.
14+
15+
Commands:
16+
list
17+
switch dut/target => connects the sdcard interface to target device
18+
19+
❯ sdwire switch --help
20+
Usage: sdwire switch [OPTIONS] COMMAND [ARGS]...
21+
22+
dut/target => connects the sdcard interface to target device
23+
24+
ts/host => connects the sdcard interface to host machine
25+
26+
off => disconnects the sdcard interface from both host and target
27+
28+
Options:
29+
-s, --serial TEXT Serial number of the sdwire device, if there is only one
30+
sdwire connected then it will be used by default
31+
--help Show this message and exit.
32+
33+
Commands:
34+
dut dut/target => connects the sdcard interface to target device
35+
host ts/host => connects the sdcard interface to host machine
36+
off off => disconnects the sdcard interface from both host and target
37+
target dut/target => connects the sdcard interface to target device
38+
ts ts/host => connects the sdcard interface to host machine
39+
```

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "sdwire"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
description = "CLI application to interact with Badgerd SDWire Gen2 devices"
55
authors = ["Talha Can Havadar <havadartalha@gmail.com>"]
66
license = "GPL-3"
@@ -13,7 +13,6 @@ click = "^8.1.7"
1313
adafruit-board-toolkit = "^1.1.1"
1414
semver = "^3.0.2"
1515
pyusb = "^1.2.1"
16-
pyudev = "^0.24.3"
1716
pyftdi = "^0.55.4"
1817

1918

0 commit comments

Comments
 (0)