From 67254c3c7ee7c205b4cfe80a833598d02833cd4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E4=B8=8D=E5=BF=98=E5=88=9D=E5=BF=83?= <1624717079@qq.com>
Date: Wed, 24 Aug 2022 14:03:25 +0800
Subject: [PATCH] Update README.md

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/README.md b/README.md
index fc74ee0..70f1926 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,51 @@
 # upyun-upx-action
 通过[又拍云upx](https://github.com/upyun/upx)推送文件到又拍云的云存储
+
+Example usage
+
+```
+name: deploy
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      - 
+        name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: 'latest'
+          extended: true
+      -
+        name: Build
+        run: hugo --minify
+      -
+        name: deploy-upyun
+        uses: bwcxyk/upyun-upx-action@main
+        env:
+          bucket: ${{ secrets.BUCKET }}
+          operator: ${{ secrets.OPERATOR }}
+          operator_password: ${{ secrets.OPERATOR_PASSWORD }}
+          local_path: ./public/
+          remote_path: /
+```
+Environment
+| Environment       | Description  |
+| ----------------- | ------------ |
+| BUCKET            | 服务名称     |
+| OPERATOR          | 操作员       |
+| OPERATOR_PASSWORD | 操作员密码   |
+| local_path        | 本地文件路径 |
+| remote_path       | 远程文件路径 |
+