Skip to content

Commit

Permalink
Add index to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IvanFon committed Mar 15, 2020
1 parent 33993ac commit 4befbe8
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ A superpowered issue and pull request labeler for Github Actions.

Super Labeler allows you to define your repository's labels in a config file that's checked into your repository. You can then define conditions that will be checked to apply and remove these labels on issues and pull requests.

- [Getting Started](#getting-started)
- [How it Works](#how-it-works)
- [Config File Format](#config-file-format)
- [Available Conditions](#available-conditions)

## Getting Started

Create a new Github Actions workflow at `.github/workflows/label.yml`:
Expand Down Expand Up @@ -83,6 +78,21 @@ Now create the labeler config file at `.github/labels.json`:

Be sure that Github Actions is enabled for in your repository's settings. Super Labeler will now run on your issues and pull requests.

## Index

- [Getting Started](#getting-started)
- [Index](#index)
- [How it Works](#how-it-works)
- [Config File Format](#config-file-format)
- [Available Conditions](#available-conditions)
- [branchMatches](#branchmatches)
- [creatorMatches](#creatormatches)
- [descriptionMatches](#descriptionmatches)
- [isDraft](#isdraft)
- [isLocked](#islocked)
- [isOpen](#isopen)
- [titleMatches](#titlematches)

## How it Works

Whenever Super Labeler runs, it will first add and update your repository's labels to match your config. Then it will go through each label's conditions to determine if it should apply or remove that label.
Expand Down

0 comments on commit 4befbe8

Please sign in to comment.