From e177d49a3a3f13deed089b38380c006f4627d924 Mon Sep 17 00:00:00 2001
From: Lunny Xiao <xiaolunwen@gmail.com>
Date: Sun, 14 May 2023 23:17:39 +0800
Subject: [PATCH] update README and add actions

---
 .gitea/workflows/test.yml | 43 +++++++++++++++++++++++++++++++++++++++
 README.md                 | 23 +++++++++++++++++++++
 2 files changed, 66 insertions(+)
 create mode 100644 .gitea/workflows/test.yml

diff --git a/.gitea/workflows/test.yml b/.gitea/workflows/test.yml
new file mode 100644
index 0000000..2af1967
--- /dev/null
+++ b/.gitea/workflows/test.yml
@@ -0,0 +1,43 @@
+name: checks
+on: 
+  - push
+  - pull_request
+
+env:
+  GOPROXY: https://goproxy.io,direct
+  GOPATH: /go_path
+  GOCACHE: /go_cache
+
+jobs:
+  lint:
+    name: check and test
+    runs-on: ubuntu-latest
+    steps:
+      - name: cache go path
+        id: cache-go-path
+        uses: https://github.com/actions/cache@v3
+        with:
+          path: /go_path
+          key: go_path-${{ github.repository }}-${{ github.ref_name }}
+          restore-keys: |
+            go_path-${{ github.repository }}-
+            go_path-                                                
+      - name: cache go cache
+        id: cache-go-cache
+        uses: https://github.com/actions/cache@v3
+        with:
+          path: /go_cache
+          key: go_cache-${{ github.repository }}-${{ github.ref_name }}
+          restore-keys: |
+            go_cache-${{ github.repository }}-
+            go_cache-                                        
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.20
+      - uses: actions/checkout@v3
+      - name: lint
+        run: go install golang.org/x/lint/golint@latest && golint ./...
+      - name: vet
+        run: go vet
+      - name: test
+        run: go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...
\ No newline at end of file
diff --git a/README.md b/README.md
index a4686d6..b677341 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
 # Release Action
 
 This action will help Gitea users to publish release and attachments.
+
+## Example
+
+```yaml
+name: release
+
+on: 
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Use Go Action  
+        id: use-go-action
+        uses: https://gitea.com/actions/release-action@main
+        with:
+          files: |-
+            bin/**
+          api_key: '${{secrets.RELEASE_TOKEN}}'
+```