update docs

rt-thread/README.md

@@ -5,47 +5,52 @@ TinyUSB for RT-Thread Port
 
 TinyUSB is an open source cross-platform USB stack for embedded system.
 
-1、 Getting start
------------------
+1 Getting Start
+----------------
 
-The specific path in RT-Thread package manager is as follows:
+### 1.1 ENV
+
+The specific path in RT-Thread ENV package manager is as follows:
 
 ``` {.sourceCode .text}
 -> RT-Thread online packages
     -> system packages
-        --- TinyUSB (offical): an open source cross-platform USB stack for embedded system
-            (2048) TinyUSB thread stack size
-            [*]   Using USB device  ---->
-                [*]   Using Communication Device Class (CDC)
-                [*]   Using Mass Storage Class (MSC)
-                ()      The name of the device used by MSC
-                  Version (latest)  --->
+        --- TinyUSB: an open source cross-platform USB stack for embedded system
+        (2048) TinyUSB thread stack size                                        
+        (8)   TinyUSB thread priority                                           
+        (.data) Memory section name                                             
+        (4)   Memory align size                                                 
+            Port number (1)  --->                                             
+            Port speed (Full Speed)  --->                                     
+        [*]   Using USB device  --->                                            
+            TinyUSB debug level (No debug)  --->                              
+            Version (v0.13.0)  --->                                            
 ```
 
-The configuration instructions for each function are as follows:
-
--   TinyUSB thread stack size
--   Whether to use a USB device
--   Using CDC
--   Using MSC
--   Name of the block device used for MSC read/write
-
 Then let the RT-Thread package manager automatically update, or use the
 `pkgs --update` command to update the package to the BSP.
 
-2、Support
-----------
+### 1.2 RT-Thread Studio
+
+Search for `TinyUSB` in RT-Thread Settings to add the package to the project.
 
-### 2.1、MCU
+![RT-Thread Studio](./assets/rt-thread-studio.png)
 
-Currently only the STM32 family of MCUs is supported.
+2 Support
+-----------
 
-### 2.2、Device class
+### 2.1 MCU
 
--   Communication Device Class (CDC)
--   Mass Storage Class (MSC)
+- STM32 series
+- nRF52840
+- HPM6000 series
 
-3、Feedback
------------
+### 2.2 Device Stack
+
+- Communication Device Class (CDC)
+- Mass Storage Class (MSC)
+- Human Interface Device (HID)
+
+# 3 Feedback
 
-issue: [tfx2001/tinyusb](https://github.com/tfx2001/tinyusb/issues)
+Issue: [RT-Thread-packages/tinyusb](https://github.com/RT-Thread-packages/tinyusb/issues)

rt-thread/README_ZH.md

@@ -1,51 +1,57 @@
-TinyUSB for RT-Thread Port
+RT-Thread TinyUSB 软件包
 ==========================
 
 中文 | [English](./README.md)
 
 TinyUSB 是一个用于嵌入式设备的跨平台 USB 协议栈。
 
-1、 打开 TinyUSB
+1、开始使用 TinyUSB
 ----------------
 
-RT-Thread 包管理器中的路径如下：
+### 1.1、ENV
+
+RT-Thread ENV 包管理器中的路径如下：
 
 ``` {.sourceCode .text}
 -> RT-Thread online packages
     -> system packages
-        --- TinyUSB (offical): an open source cross-platform USB stack for embedded system
-            (2048) TinyUSB thread stack size
-            [*]   Using USB device  ---->
-                [*]   Using Communication Device Class (CDC)
-                [*]   Using Mass Storage Class (MSC)
-                ()      The name of the device used by MSC
-                  Version (latest)  --->
+        --- TinyUSB: an open source cross-platform USB stack for embedded system
+        (2048) TinyUSB thread stack size                                        
+        (8)   TinyUSB thread priority                                           
+        (.data) Memory section name                                             
+        (4)   Memory align size                                                 
+            Port number (1)  --->                                             
+            Port speed (Full Speed)  --->                                     
+        [*]   Using USB device  --->                                            
+            TinyUSB debug level (No debug)  --->                              
+            Version (v0.13.0)  --->                                            
 ```
 
-功能配置说明如下：
-
--   TinyUSB 线程栈大小
--   是否使用 USB 设备
-    -   是否使用 CDC
-    -   是否使用 MSC
-    -   用于 MSC 读写的块设备名字
-
 然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update`
 命令更新包到 BSP 中。
 
+### 1.2、RT-Thread Studio
+
+在 RT-Thread Settings 中搜索 `TinyUSB` 即可将软件包添加至工程中。
+
+![RT-Thread Studio](./assets/rt-thread-studio.png)
+
 2、支持情况
 -----------
 
 ### 2.1、MCU
 
-目前仅支持 STM32 系列 MCU。
+- STM32 系列
+- nRF52840
+- HPM6000 系列
 
 ### 2.2、设备类
 
--   通信设备类（CDC）
--   大容量存储设备（MSC）
+-   通信设备类 (CDC)
+-   大容量存储设备 (MSC)
+-   人体学输入设备 (HID)
 
 3、Feedback
 -----------
 
-issue: [RT-Thread-packages/tinyusb](https://github.com/RT-Thread-packages/tinyusb/issues)
+Issue: [RT-Thread-packages/tinyusb](https://github.com/RT-Thread-packages/tinyusb/issues)