From a7d77f0660d17694be5ffb2b4559f6b6b737e6ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?King=20K=C3=A9vin?= Date: Wed, 20 Mar 2024 05:07:12 +0100 Subject: [PATCH] doc: add purpose --- CHANGELOG.md | 6 ++++++ README.md | 15 ++++++++++++++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..b3b25fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +v0 +== + +this is a large development board. +it accepts the classical STM32F103 (which I'm more familiar with), and CH32V203 (cheaper). +it has a proper debug port and buttons. diff --git a/README.md b/README.md index 7c35594..c944e0a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -these are the hardware design files for **insert project name here**. +passkey type your credentials for you. purpose ======= +This USB dongle will help you out if you have to enter your credentials frequently. +Temporarily store the credential on it, and press a button for passkey to enter it for you. + usage ===== + +- passkey will appear as USB serial port and keyboard +- connect to it using a serial terminal (baud rate it not important) +- enter the credentials you often have to input +- press on the U button for passkey to input the username and password +- press on the P button for passkey to input password + +The credentials are save in RAM and will clear as soon a power is removed. +You can also clear the credentials by pressing on both buttons. +The passkey will blink until credentials are saved.