From 8160979e3acc92ad26cc3e109788cb857ba40f60 Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Thu, 25 Dec 2025 09:23:16 +0000
Subject: [PATCH] Add README.md

---
 README.en.md | 54 +++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 116 insertions(+)
 create mode 100644 README.en.md
 create mode 100644 README.md

diff --git a/README.en.md b/README.en.md
new file mode 100644
index 0000000..6afe22a
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,54 @@
+# CountdownButton Project Documentation
+
+This is a component project based on OpenHarmony, primarily implementing a countdown button (CountDownButton) feature. The project structure is clear and facilitates quick integration into other applications.
+
+## Directory Structure
+
+- `CountDownButtonDemo/`: Main project folder containing source code and resource files.
+  - `countDownButton/`: Source code and configuration files for the countdown button component.
+    - `src/main/ets/components/`: Contains the core component code `CountDownButton.ets`.
+    - `oh-package.json5`: Component dependency configuration file.
+  - `entry/`: Main module of the application, including the launch page and ability classes.
+    - `src/main/ets/pages/`: Page logic code.
+    - `src/main/resources/`: Resource files such as images and color configurations.
+  - `hvigor/`: Build configuration directory.
+  - `LICENSE`: Project license file.
+  - `README.md`: This file, providing an overview and usage guide.
+
+## Features
+
+- The countdown button component supports customizable styles and countdown duration.
+- Designed for easy integration into OpenHarmony applications.
+- Includes comprehensive documentation and sample code for quick start.
+
+## Usage Steps
+
+1. **Clone the Project**:
+   ```bash
+   git clone https://gitee.com/zggx/countdownbutton.git
+   ```
+
+2. **Import the Project**:
+   Open the `CountDownButtonDemo` folder using the OpenHarmony IDE.
+
+3. **Run the Project**:
+   Run the project on an emulator or real device to view the countdown button in action.
+
+4. **Integrate the Component**:
+   Add the `countDownButton` module as a dependency in your project and reference the `CountDownButton` component in your pages.
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `duration` | number | Countdown duration in seconds. |
+| `onFinish` | function | Callback function triggered when the countdown ends. |
+| `style` | object | Custom button styling. |
+
+## Open Source License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.
+
+## Contribution Guidelines
+
+Issues and pull requests are welcome to help improve this project.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..64c556c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+根据您提供的代码库结构，以下是一个适用于此项目的 README.md 内容模板。由于无法访问实际文件内容，以下内容是基于常规项目结构的通用建议，您可以根据实际情况调整：
+
+---
+
+# CountdownButton 项目说明
+
+这是一个基于 OpenHarmony 的组件项目，主要实现了一个倒计时按钮（CountDownButton）的功能。项目结构清晰，便于快速集成到其他应用中。
+
+## 目录结构
+
+- `CountDownButtonDemo/`：主项目文件夹，包含应用的源代码和资源文件。
+  - `countDownButton/`：倒计时按钮组件的源码及配置文件。
+    - `src/main/ets/components/`：包含 `CountDownButton.ets` 核心组件代码。
+    - `oh-package.json5`：组件的依赖配置文件。
+  - `entry/`：应用的主模块，包含启动页面和能力类。
+    - `src/main/ets/pages/`：页面逻辑代码。
+    - `src/main/resources/`：资源文件，如图片、颜色配置等。
+  - `hvigor/`：构建配置目录。
+  - `LICENSE`：项目许可证文件。
+  - `README.md`：本文件，提供项目概述和使用指南。
+
+## 功能特性
+
+- 倒计时按钮组件支持自定义样式和倒计时时间。
+- 支持在 OpenHarmony 应用中快速集成。
+- 提供详细的文档和示例代码，便于上手。
+
+## 使用步骤
+
+1. **克隆项目**：
+   ```bash
+   git clone https://gitee.com/zggx/countdownbutton.git
+   ```
+
+2. **导入项目**：
+   使用 OpenHarmony IDE 打开 `CountDownButtonDemo` 文件夹。
+
+3. **运行项目**：
+   在模拟器或真实设备上运行项目，查看倒计时按钮效果。
+
+4. **集成组件**：
+   将 `countDownButton` 模块作为依赖添加到您的项目中，并在页面中引用 `CountDownButton` 组件。
+
+## 参数说明
+
+| 参数名 | 类型 | 说明 |
+|--------|------|------|
+| `duration` | number | 倒计时时间，单位为秒。 |
+| `onFinish` | function | 倒计时结束时触发的回调函数。 |
+| `style` | object | 自定义按钮样式。 |
+
+## 开源许可
+
+本项目采用 MIT License，详情请查看 `LICENSE` 文件。
+
+## 贡献指南
+
+欢迎提交 Issue 和 Pull Request，帮助我们改进项目。
+
+--- 
+
+请根据实际代码内容补充详细说明和示例。
\ No newline at end of file
-- 
Gitee