Skip to content

Commit

Permalink
Promote the why to the top of the README (#106)
Browse files Browse the repository at this point in the history
It makes sense to make the "why" more prominent, so that people see why
this label checker is a good one for them to use.
  • Loading branch information
johnboyes authored Aug 17, 2020
1 parent 991806c commit 6f0a10e
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,22 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/agilepathway/label-checker)](https://goreportcard.com/report/github.com/agilepathway/label-checker)
[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/agilepathway/label-checker)](https://golang.org/)


---

**[GitHub Action](https://github.com/features/actions) to check pull requests (PRs) for the presence or absence of specified labels**

---


## Why another label checker?

- We couldn't find another label checker that had all [our 4 check types](#checks) (`one_of`, `none_of`, `all_of`, `any_of`)

- **Speed**: the [Docker image](https://hub.docker.com/repository/docker/agilepathway/pull-request-label-checker)
used for the checks is only 2.7 MB, so the checks are blazingly fast (c. 3 seconds)


## Using the Label Checker action

Using this action is as simple as:
Expand Down Expand Up @@ -127,14 +141,6 @@ The project is [open source](https://opensource.guide/how-to-contribute/) and al
* [Local development](CONTRIBUTING.md#local-development)

* [Running the tests](CONTRIBUTING.md#running-the-tests)


## Why another label checker?

- We couldn't find another label checker that had all the 4 check types available

- Speed: the [Docker image](https://hub.docker.com/repository/docker/agilepathway/pull-request-label-checker)
used for the checks is only 2.7 MB, so the checks are blazingly fast (c. 3 seconds)


## Updating dependencies
Expand Down

0 comments on commit 6f0a10e

Please sign in to comment.