Skip to content

Commit 43894bb

Browse files
committed
Highlight documentation website in README files
- Add prominent documentation section with website link - Include detailed description of documentation contents - Make documentation easily discoverable for users - Add visual separators and emojis for better readability - Update both English and Chinese README files
1 parent 41f6448 commit 43894bb

File tree

2 files changed

+36
-4
lines changed

2 files changed

+36
-4
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
# GitHub Action Parser
22

3-
[![Go Reference](https://pkg.go.dev/badge/github.com/scagogogo/github-action-parser.svg)](https://pkg.go.dev/github.com/scagogogo/github-action-parser)
3+
[![Go Reference](https://pkg.go.dev/badge/github.com/scagogogo/github-action-parser.svg)](https://pkg.go.dev/github.com/scagogogo/github-action-parser)
44
[![Go CI](https://github.com/scagogogo/github-action-parser/actions/workflows/ci.yml/badge.svg)](https://github.com/scagogogo/github-action-parser/actions/workflows/ci.yml)
55
[![Documentation](https://github.com/scagogogo/github-action-parser/actions/workflows/docs.yml/badge.svg)](https://scagogogo.github.io/github-action-parser/)
66
[![Coverage](https://img.shields.io/badge/coverage-98.9%25-brightgreen)](https://github.com/scagogogo/github-action-parser)
77

88
A Go library for parsing, validating and processing GitHub Action YAML files.
99

10-
**📖 [Documentation](https://scagogogo.github.io/github-action-parser/) | [中文文档](https://scagogogo.github.io/github-action-parser/zh/)**
10+
---
11+
12+
## 📚 Documentation
13+
14+
**🌐 [Complete Documentation Website](https://scagogogo.github.io/github-action-parser/)**
15+
16+
- 📖 [English Documentation](https://scagogogo.github.io/github-action-parser/)
17+
- 🇨🇳 [中文文档](https://scagogogo.github.io/github-action-parser/zh/)
18+
19+
The documentation includes:
20+
- 🚀 **Getting Started Guide** - Quick setup and basic usage
21+
- 📋 **API Reference** - Complete API documentation with examples
22+
- 💡 **Examples** - Practical code examples and use cases
23+
-**Validation Guide** - How to validate actions and workflows
24+
- 🔄 **Reusable Workflows** - Working with reusable workflows
25+
26+
---
1127

1228
## Features
1329

README.zh-CN.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
# GitHub Action Parser
22

3-
[![Go Reference](https://pkg.go.dev/badge/github.com/scagogogo/github-action-parser.svg)](https://pkg.go.dev/github.com/scagogogo/github-action-parser)
3+
[![Go Reference](https://pkg.go.dev/badge/github.com/scagogogo/github-action-parser.svg)](https://pkg.go.dev/github.com/scagogogo/github-action-parser)
44
[![Go CI](https://github.com/scagogogo/github-action-parser/actions/workflows/ci.yml/badge.svg)](https://github.com/scagogogo/github-action-parser/actions/workflows/ci.yml)
55
[![Documentation](https://github.com/scagogogo/github-action-parser/actions/workflows/docs.yml/badge.svg)](https://scagogogo.github.io/github-action-parser/)
66
[![Coverage](https://img.shields.io/badge/coverage-98.9%25-brightgreen)](https://github.com/scagogogo/github-action-parser)
77

88
一个用于解析、验证和处理 GitHub Action YAML 文件的 Go 库。
99

10-
**📖 [文档](https://scagogogo.github.io/github-action-parser/zh/) | [English Documentation](https://scagogogo.github.io/github-action-parser/)**
10+
---
11+
12+
## 📚 文档
13+
14+
**🌐 [完整文档网站](https://scagogogo.github.io/github-action-parser/)**
15+
16+
- 🇨🇳 [中文文档](https://scagogogo.github.io/github-action-parser/zh/)
17+
- 📖 [English Documentation](https://scagogogo.github.io/github-action-parser/)
18+
19+
文档包含:
20+
- 🚀 **快速开始指南** - 快速设置和基本用法
21+
- 📋 **API 参考** - 完整的 API 文档和示例
22+
- 💡 **示例代码** - 实用的代码示例和用例
23+
-**验证指南** - 如何验证 actions 和 workflows
24+
- 🔄 **可重用工作流** - 处理可重用工作流
25+
26+
---
1127

1228
## 功能特点
1329

0 commit comments

Comments
 (0)