From b530f2627defc896e4a45deb6a93515f8dfd919e Mon Sep 17 00:00:00 2001
From: Kinchin Fong <v@vvzero.com>
Date: Sun, 16 Apr 2023 21:37:48 +0800
Subject: [PATCH] add README

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b32fe3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# DreamTap
+
+A smart switch for developers!
+
+## Usage
+
+1. Install VSCode;
+2. Install PlatformIO plugin for VSCode;
+3. Copy `include/config_sample.h` to `include/config.h`;
+4. Modify `include/config.h` as you wish;
+5. Compile this sketch;
+6. Connect DreamTap to your computer;
+7. Press the side-button and main button at the same time, release main button first, then release side button;
+8. Upload this sketch to DreamTap;