Merge pull request #4 from soulteary/docs/update-docs

docs: update docs

Author: soulteary

LICENSE

@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    <program>  Copyright (C) <year>  <name of author>
+    CAN-FINDER  Copyright (C) 2025 LinkerBot,Ltd.
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

README.md

@@ -1,2 +1,93 @@
-# can-finder
-Find CAN devices in the network
+# CAN Finder Project Description
+
+[中文文档](./README_zhCN.md)
+
+## Project Overview
+
+**CAN Finder** is a network device auto-discovery and management tool specifically designed for LinkerHand devices. The tool listens for UDP broadcasts from devices, displays their essential information in real-time, such as device name, IP address, MAC address, model, and version information, and pushes updates to the frontend via the WebSocket protocol.
+
+## Features
+
+* **Real-Time Device Discovery**: Listens to UDP broadcast data to discover CAN devices in real-time.
+* **Web Interface Display**: Provides an intuitive web interface to show detailed device information, including first discovery time and last active time.
+* **WebSocket Communication**: Uses WebSocket to update device status in real-time without manual refresh.
+
+## System Architecture
+
+CAN Finder consists of two main components:
+
+1. **Backend Service**: Written in Go, using the Gin web framework to provide HTTP services, WebSocket services, and UDP broadcast listening.
+2. **Frontend Display Page**: Built with native HTML and JavaScript, communicating with the backend in real-time through WebSockets.
+
+## Technology Stack
+
+* Go Language
+* Gin Framework
+* WebSocket (Gorilla)
+* HTML and JavaScript
+* UDP Broadcast Protocol
+
+## Usage
+
+### Installation and Execution
+
+```shell
+go build -o can-finder
+./can-finder --http-port 6200 --udp-port 9999
+```
+
+### Accessing the Web Interface
+
+After starting the service, access it through a browser at:
+
+```
+http://localhost:6200
+```
+
+This will allow real-time monitoring of CAN device discovery.
+
+## Project Structure
+
+```
+can-finder/
+├── main.go             # Backend core program, handling UDP broadcasts and HTTP/WebSocket requests
+└── public
+    └── index.html      # Frontend display page
+```
+
+## Configuration Details
+
+* Default HTTP server listening port: `6200` (modifiable via command-line parameters)
+* Default UDP broadcast listening port: `9999` (modifiable via command-line parameters)
+
+## Example Webpage Display
+
+The frontend display page updates device information in real-time, including:
+
+* Device Name
+* IP Address
+* MAC Address
+* Device Model
+* Software Version (linked to GitHub Release page)
+* First Discovery Time
+* Last Active Time
+
+## Error Handling and Logging
+
+The backend service provides detailed logs to quickly diagnose device discovery and communication issues.
+
+## Dependencies
+
+* github.com/gin-gonic/gin
+* github.com/gorilla/websocket
+* github.com/soulteary/gin-static
+
+Use `go mod tidy` for automatic dependency management.
+
+## License
+
+This project uses the GPL-3.0 license.
+
+---
+
+Contributions are welcome! Feel free to submit code, raise issues, or open pull requests to help us continuously optimize and enhance CAN Finder!

README_zhCN.md

@@ -0,0 +1,93 @@
+# CAN Finder 项目说明
+
+[English](./README.md)
+
+## 项目概述
+
+**CAN Finder** 是一款专为灵心巧手设备设计的网络设备自动发现和管理工具。该项目通过监听设备发送的 UDP 广播，实时展示设备的基本信息，包括设备名、IP 地址、MAC 地址、设备型号和版本信息，并通过 WebSocket 协议向前端实时推送更新。
+
+## 功能特性
+
+* **实时设备发现**：通过监听 UDP 广播数据，实时发现网络中的 CAN 设备。
+* **Web 界面展示**：通过友好的 Web 界面直观展示设备详细信息，包含首次发现和最后活跃时间。
+* **WebSocket 通信**：利用 WebSocket 协议实时更新设备状态，无需手动刷新。
+
+## 系统架构
+
+CAN Finder 由两个主要部分组成：
+
+1. **后端服务**：采用 Go 语言编写，使用 Gin Web 框架提供 HTTP 服务、WebSocket 服务和 UDP 广播监听。
+2. **前端展示页面**：采用原生 HTML 和 JavaScript 构建，通过 WebSocket 与后端实时交互。
+
+## 技术栈
+
+* Go 语言
+* Gin 框架
+* WebSocket (Gorilla)
+* HTML 和 JavaScript
+* UDP 广播协议
+
+## 使用方法
+
+### 安装运行
+
+```shell
+go build -o can-finder
+./can-finder --http-port 6200 --udp-port 9999
+```
+
+### 访问 Web 界面
+
+启动服务后，通过浏览器访问：
+
+```
+http://localhost:6200
+```
+
+即可实时查看 CAN 设备的发现情况。
+
+## 项目结构
+
+```
+can-finder/
+├── main.go             # 后端核心程序，处理UDP广播及HTTP/WebSocket请求
+└── public
+    └── index.html      # 前端展示页面
+```
+
+## 配置说明
+
+* HTTP 服务默认监听端口：`6200`（可通过命令行参数修改）
+* UDP 广播监听默认端口：`9999`（可通过命令行参数修改）
+
+## 示例页面展示
+
+前端展示页面实时更新设备信息，包括：
+
+* 设备名
+* IP 地址
+* MAC 地址
+* 设备型号
+* 软件版本（链接至 GitHub Release 页面）
+* 首次发现时间
+* 最后活跃时间
+
+## 错误处理与日志
+
+后端服务提供丰富的日志信息，以快速排查设备发现及通信相关问题。
+
+## 项目依赖
+
+* github.com/gin-gonic/gin
+* github.com/gorilla/websocket
+* github.com/soulteary/gin-static
+
+使用 `go mod tidy` 自动管理依赖。
+
+## License
+
+本项目采用 GPL-3.0 license。
+
+---
+
+欢迎贡献代码、提出 Issue 或提交 PR，帮助我们不断优化和完善 CAN Finder！