Skip to content

Commit 3b25b96

Browse files
committed
feat: update README
1 parent e9dc5ef commit 3b25b96

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,37 @@
11
# PowerKey
22

3-
> - Your password is too long to type or to remember?
3+
> - Your password is too long to remember?
44
> - Try PowerKey instead!
55
6+
![Preview](./docs/demo.gif)
7+
68
## Brief
79

810
PowerKey is a simple single-key device which acts as a USB-keyboard and automatically types password, or any another preprogrammed string.
911

12+
## Building
13+
1014
### Ingredients
1115

12-
* 1x Arduino Pro Micro.
13-
* 2x LEDs + 220Ω resistors.
14-
* 1x Cherry MX or another switch.
15-
* 1x Button.
16+
* 1x Arduino Pro Micro
17+
* 2x LEDs + 220Ω resistors
18+
* 1x Cherry MX or another switch
19+
* 1x Button
20+
* 3D Printer (optionally, to print [housing](./docs/3d-print/PowerKeyCase.f3d))
21+
22+
> [!NOTE]
23+
> See [include/config.h](include/config.h) for pinout config.
24+
25+
## Firmware
26+
27+
Use `make build` and `make upload` to flash a board.
28+
29+
> [!IMPORTANT]
30+
> PlatformIO is required to build the project. Install [PlatformIO CLI](https://docs.platformio.org/en/latest/core/index.html) or [VSCode extension](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide).
31+
32+
## Housing
33+
34+
You can find a Fusion 360 project [here](./docs/3d-print/PowerKeyCase.f3d).
1635

1736
## Configuration
1837

@@ -24,4 +43,3 @@ See [include/config.h](include/config.h) for pinout configuration and firmware o
2443

2544
Use [PowerKey Programmer](https://x1unix.github.io/powerkey/flasher) web tool to re-program a device and update stored password.
2645

27-

docs/demo.gif

11.9 MB
Loading

0 commit comments

Comments
 (0)