Skip to content

Commit 1f2a96c

Browse files
authored
docs: clarify that still YAML files are generated (#1637)
Be more clear about the "two-step approach" that still requires YAML files to be generated underneath, which serve as the definition of workflows. This should help to avoid the impression that the project can be used as a complete substitute for using YAML files at all.
1 parent 465fdb9 commit 1f2a96c

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
[![License](https://img.shields.io/github/license/typesafegithub/github-workflows-kt)](https://github.com/typesafegithub/github-workflows-kt/blob/main/LICENSE)
99
[![github-workflows-kt @ kotlinlang.slack.com](https://img.shields.io/static/v1?label=kotlinlang&message=github-workflows-kt&color=blue&logo=slack)](https://kotlinlang.slack.com/archives/C02UUATR7RC)
1010

11-
[github-workflows-kt](https://github.com/typesafegithub/github-workflows-kt/) is a tool for creating
12-
[GitHub Actions workflows](https://docs.github.com/en/actions/using-workflows) in a **type-safe** script, helping you to
11+
[github-workflows-kt](https://github.com/typesafegithub/github-workflows-kt/) is a tool for generating
12+
[GitHub Actions workflow](https://docs.github.com/en/actions/using-workflows) YAML files in a **type-safe** script, helping you to
1313
build **robust** workflows for your GitHub projects without mistakes, with **pleasure**, in
1414
[Kotlin](https://kotlinlang.org/).
1515

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# github-workflows-kt
22

3-
github-workflows-kt is a tool for creating
4-
[GitHub Actions workflows](https://docs.github.com/en/actions/using-workflows) in a **type-safe** script, helping you to
3+
github-workflows-kt is a tool for generating
4+
[GitHub Actions workflow](https://docs.github.com/en/actions/using-workflows) YAML files in a **type-safe** script, helping you to
55
build **robust** workflows for your GitHub projects without mistakes, with **pleasure**, in
66
[Kotlin](https://kotlinlang.org/).
77

0 commit comments

Comments
 (0)