From ab8e10b92d0eaabbc53cd6ce9db97d2f66cda6e8 Mon Sep 17 00:00:00 2001 From: JJ Merelo Date: Fri, 16 Feb 2024 20:09:35 +0100 Subject: [PATCH] :recycle: :bug: #118 --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e65768a9..9a868c44 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -# Checking pull request bodies and diffs for words, and number of files and lines in files changed [![Basic installation and build checks](https://github.com/JJ/github-pr-contains-action/actions/workflows/checkin.yml/badge.svg)](https://github.com/JJ/github-pr-contains-action/actions/workflows/checkin.yml) +# A GitHub action that checks pull requests description and contents [![Basic installation and build checks](https://github.com/JJ/github-pr-contains-action/actions/workflows/install-build-checks.yml/badge.svg)](https://github.com/JJ/github-pr-contains-action/actions/workflows/install-build-checks.yml) -Originally based on the [actions TS -template](https://github.com/actions/typescript-template), it checks for the -presence/absence of a string or group of strings in the body or diff in a PR, as -well as certain conditions on the PR: number of files changed, and number of -lines changed. +This GitHub action checks for the presence/absence of a string or group of +strings in the body or diff, as well as certain conditions in the PR: number of +files changed, and number of lines changed. It uses the GitHub API, so you'll need to provide a token. Don't worry, that's built-in.