Skip to content

Commit 5b1bac0

Browse files
committed
docs(README): Improve introduction
Improved introductory wording for clarity, added a link to GitHub actions documentation to better assist novice users. Signed-off-by: Thomas Steenbergen <[email protected]>
1 parent c459463 commit 5b1bac0

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# GitHub Action for ORT
22

3-
Run licensing, security and best practices checks and generate reports/SBOMs using [ORT][ort].
3+
Run licensing, security, best practices checks and generate reports/Software Bill of Materials (SBOMs) using [ORT][ort]
4+
within [GitHub Actions][gh-action-docs].
45

56
## Usage
67

@@ -334,6 +335,7 @@ See the [LICENSE](./LICENSE) file in the root of this project for license detail
334335
OSS Review Toolkit (ORT) is a [Linux Foundation project][lf] and part of [ACT][act].
335336

336337
[act]: https://automatecompliance.org/
338+
[gh-action-docs]: https://docs.github.com/en/actions
337339
[gh-action-secrets]: https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository
338340
[gh-tokens]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
339341
[ort]: https://github.com/oss-review-toolkit/ort

0 commit comments

Comments
 (0)