From adb13be1897695e97a5a3791e964b875bd917865 Mon Sep 17 00:00:00 2001
From: DDSRem <1448139087@qq.com>
Date: Sat, 9 Sep 2023 21:16:58 +0800
Subject: [PATCH] docs: update

---
 .github/workflows/build.yml         |  3 +++
 .github/workflows/readme_update.yml | 28 ++++++++++++++++++++++++++++
 README.md                           | 21 ++++++++++++++++++++-
 3 files changed, 51 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/readme_update.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 714c74f..14a62ce 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -5,6 +5,9 @@ on:
   push:
     branches:
       - master
+    paths:
+      - Dockerfile
+      - rootfs
 
 jobs:
   build:
diff --git a/.github/workflows/readme_update.yml b/.github/workflows/readme_update.yml
new file mode 100644
index 0000000..a888f38
--- /dev/null
+++ b/.github/workflows/readme_update.yml
@@ -0,0 +1,28 @@
+name: Docker readme update
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    paths:
+      - README.md
+
+jobs:
+  job:
+    name: Docker Hub Description
+    runs-on: ubuntu-latest
+    steps:
+      - 
+        name: Checkout
+        uses: actions/checkout@v4
+
+      - 
+        name: Docker Hub Description
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          repository: ${{ secrets.DOCKER_USERNAME }}/wxchat
+          short-description: 微信转发代理
+          readme-filepath: ./README.md
\ No newline at end of file
diff --git a/README.md b/README.md
index cf7a51a..39fb8ac 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,20 @@
-# wxchat-Docker
\ No newline at end of file
+# 微信转发代理 Docker
+
+```bash
+docker run -d \
+    --name wxchat \
+    --restart=always \
+    -p 80:80 \
+    ddsderek/wxchat:latest
+```
+
+```yaml
+version: '3.3'
+services:
+    wxchat:
+        container_name: wxchat
+        restart: always
+        ports:
+            - '80:80'
+        image: 'ddsderek/wxchat:latest'
+```
\ No newline at end of file