From 0b1530c6a1d49ce81606f7b6378561b2f49fd1e1 Mon Sep 17 00:00:00 2001
From: Carm <carm@carm.cc>
Date: Tue, 30 Jul 2024 06:04:10 +0800
Subject: [PATCH] doc: Add more docs

---
 {doc => .doc}/img/demo.jpg         | Bin
 res/base.STL => .res/baseboard.STL | Bin
 README.md                          |  19 ++++++++++++++++++-
 3 files changed, 18 insertions(+), 1 deletion(-)
 rename {doc => .doc}/img/demo.jpg (100%)
 rename res/base.STL => .res/baseboard.STL (100%)

diff --git a/doc/img/demo.jpg b/.doc/img/demo.jpg
similarity index 100%
rename from doc/img/demo.jpg
rename to .doc/img/demo.jpg
diff --git a/res/base.STL b/.res/baseboard.STL
similarity index 100%
rename from res/base.STL
rename to .res/baseboard.STL
diff --git a/README.md b/README.md
index e53367c..0a0d6d0 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,27 @@
 
 Simple **smart curtains** controller based on **Arduino Uno R3** with [OpenJumper](https://www.openjumper.com/)'s module.
 
-![](doc/img/demo.jpg)
+![](.doc/img/demo.jpg)
 
 ![OpenJumper](https://www.openjumper.com/assets/img/logo-red.png)
 
+## Features
+
+- Knob to control the curtains position (0-100%)
+- Button to execute the command
+- LCD to indicate the status of the curtains
+
+## Components
+
+- 1 x Arduino Uno R3
+- 1 x OpenJumper Motherboard
+- 1 x Stepper Motor
+- 1 x Stepper Motor Driver
+- 1 x OpenJumper Button
+- 1 x OpenJumper Knob
+- 1 x OpenJumper LCD (1602A/PCF8574)
+- 1 x 3D-Printed Baseboard (optional) [3D Print](.res/baseboard.STL)
+
 ## Open Source Licence
 
 The source code of this project adopts the [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0).