docs: Updated README: Added comprehensive usage documentation with video walkthrough

node-hub/dora-kit-car/README.md

@@ -1,10 +1,16 @@
-# Chongyou Car Control
+# dora-kit-car control
 
 ## Introduce
 
-Control of the movement of the trolley by receiving texts
+Dora Kit Car is a DORA node for controlling a differential-drive mobile robot to move forward/backward and turn left/right. Developed in Rust with Python API support.
 
-## Usage
+## Highlights
+
+- Compatible with the ROS geometry_msgs/Twist.msg format, utilizing only:
+- linear.x (positive: forward movement, negative: backward movement)
+- angular.z (positive: left turn, negative: right turn)
+
+## Raw Message Definition
 
 Accepts an array of six f64's
 
@@ -14,6 +20,36 @@ see [https://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Twist.html](https
 
 ## Environment
 
-The default serial port is `/dev/ttyUSB0`
+Adds an environment variable `SERIAL_PORT` to specify the serial port for the car device, with `/dev/ttyUSB0` as the default value
+
+## Demo Video
+
+[![Dora Kit Car Video](https://yt3.ggpht.com/92FGXQL59VsiXim13EJQek4IB7CRI-9SjmW3LhH8PFY16oBXqKUvkKhg5UdzLiGCOmoSuTvdpQxIuw=s640-rw-nd-v1)](https://youtu.be/B7zGHtRUZSo)
+
+## Getting Started
+
+```yaml
+nodes:
+  - id: keyboard-listener # Run on car
+    build: pip install dora-keyboard
+    path: dora-keyboard
+    inputs:
+      tick: dora/timer/millis/10
+    outputs:
+      - twist # for example [2.0,0.0,0.0,0.0,0.0,1.0]
+
+  - id: car
+    build: pip install dora-kit-car
+    path: dora-kit-car
+    inputs:
+      keyboard: keyboard-listener/twist
+    env:
+      SERIAL_PORT: /dev/ttyUSB0
+
+```
+
+## License
+
+The MIT License (MIT)
 
-Added definition of default serial port number. Can additionally define the environment variable `SERIAL_PORT`
+Copyright (c) 2024-present, Leon