feat: add README file

README.md

@@ -0,0 +1,69 @@
+# Update-APT-Source GitHub Action
+
+A GitHub Action for managing Debian/Ubuntu APT repositories, parsing .deb packages and publishing them to cloud storage services.
+
+## Features
+
+- Parse and process Debian package (.deb) files
+- Support various compression formats (gz, xz, zst) for control files
+- Generate complete APT repository structure (Packages, Release files)
+- Calculate and verify checksums (MD5, SHA1, SHA256, SHA512)
+- Implement GPG signing to ensure repository security
+- Support multiple architectures (amd64, arm64, etc.)
+- Support multiple Ubuntu distributions (bionic, focal, jammy, noble, etc.)
+- Integration with Aliyun OSS storage service
+
+## Usage in GitHub Workflow
+
+Create a workflow file in your GitHub repository (e.g.: `.github/workflows/update-apt.yml`):
+
+```yaml
+name: Update APT Repository
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  update-apt-repo:
+  runs-on: ubuntu-latest
+  steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Update APT Source
+      uses: coscene-io/update-apt-source@v1
+      with:
+        ubuntu-distro: noble
+        deb-paths: |
+            ./dist/myapp_1.0.0_amd64.deb
+            ./dist/myapp_1.0.0_arm64.deb
+        architectures: |
+            amd64
+            arm64
+        oss-key-id: ${{ secrets.ALIYUN_ACCESS_KEY_ID }}
+        oss-key-secret: ${{ secrets.ALIYUN_ACCESS_KEY_SECRET }}
+        gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+```
+
+## Inputs
+
+| Input Name | Description | Required |
+|------------|-------------|----------|
+| `ubuntu-distro` | Ubuntu distribution codename (e.g., `focal`, `jammy`, or `all`) | Yes |
+| `deb-paths` | Paths to .deb packages, separated by newlines | Yes |
+| `architectures` | Architectures for each .deb package, separated by newlines, in the same order as deb-paths, with the same number of entries as deb-paths | Yes |
+| `oss-key-id` | Aliyun OSS Access Key ID | Yes |
+| `oss-key-secret` | Aliyun OSS Access Key Secret | Yes |
+| `gpg-private-key` | GPG private key for signing | Yes |
+
+## How It Works
+
+1. Parse specified .deb packages and extract metadata
+2. Generate APT repository structure based on specified Ubuntu distribution and architecture
+3. Create Packages file containing detailed information of all packages
+4. Generate and sign Release file to ensure repository integrity
+5. Upload packages and metadata files to Aliyun OSS storage
+
+## Security Note
+
+Always use GitHub repository Secrets to store sensitive information like keys and tokens. Never expose these values directly in your workflow files.

README_CN.md

@@ -0,0 +1,69 @@
+# Update-APT-Source GitHub Action
+
+一个用于管理Debian/Ubuntu APT软件源的GitHub Action，支持解析.deb包并将其发布到云存储服务。
+
+## 功能特点
+
+- 解析和处理Debian软件包(.deb)文件
+- 支持多种压缩格式(gz、xz、zst)的控制文件
+- 生成完整的APT仓库结构(Packages、Release文件等)
+- 计算并验证各种校验和(MD5, SHA1, SHA256, SHA512)
+- 使用GPG进行签名，确保软件源安全性
+- 支持多架构(amd64, arm64等)
+- 支持多个Ubuntu发行版(bionic, focal, jammy, noble等)
+- 与阿里云OSS存储服务集成
+
+## 在GitHub Workflow中使用
+
+在你的GitHub仓库中创建一个工作流程文件（如：`.github/workflows/update-apt.yml`）：
+
+```yaml
+name: Update APT Repository
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  update-apt-repo:
+  runs-on: ubuntu-latest
+  steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Update APT Source
+      uses: coscene-io/update-apt-source@v1
+      with:
+        ubuntu-distro: noble
+        deb-paths: |
+            ./dist/myapp_1.0.0_amd64.deb
+            ./dist/myapp_1.0.0_arm64.deb
+        architectures: |
+            amd64
+            arm64
+        oss-key-id: ${{ secrets.ALIYUN_ACCESS_KEY_ID }}
+        oss-key-secret: ${{ secrets.ALIYUN_ACCESS_KEY_SECRET }}
+        gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+```
+
+## 输入参数
+
+| 参数名               | 描述                                                    | 是否必需 |
+|-------------------|-------------------------------------------------------|------|
+| `ubuntu-distro`   | Ubuntu发行版代号(如`focal`, `jammy` 等，或者 `all`)             | 是    |
+| `deb-paths`       | .deb包的路径，多个路径用换行符分隔                                   | 是    |
+| `architectures`   | 对应每个.deb包的架构，多个架构用换行符分隔，顺序与deb-paths一致，数量与deb-paths一致 | 是    |
+| `oss-key-id`      | 阿里云OSS的Access Key ID                                  | 是    |
+| `oss-key-secret`  | 阿里云OSS的Access Key Secret                              | 是    |
+| `gpg-private-key` | 用于签名的GPG私钥                                            | 是    |
+
+## 工作原理
+
+1. 解析指定的.deb包，提取元数据信息
+2. 根据指定的Ubuntu发行版和架构，生成APT仓库结构
+3. 生成Packages文件，包含所有软件包的详细信息
+4. 创建并签名Release文件，确保软件源完整性
+5. 将软件包和元数据文件上传到阿里云OSS存储
+
+## 安全提示
+
+存储敏感信息（如密钥和令牌）请使用GitHub仓库的Secrets功能。请勿直接在工作流文件中暴露这些值。