Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.69 KB

README.md

File metadata and controls

71 lines (51 loc) · 2.69 KB

Visitor Badge

Adds a badge to count visitors for your issues and PRs.

screenshot

Usage

Create .github/workflows/visitor-badge.yml in the default branch:

name: Visitor Badge
on:
  pull_request:
    types: [opened]
  issues:
    types: [opened]
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/visitor-badge@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Inputs

GITHUB_TOKEN

Your GitHub token for authentication.

color

The color or the badge. You can use any valid HEX color or pick from a predefined set of named colors. Default is blue. Note that the HEX colors should be used without # symbol prefix.

color demo
brightgreen
green
yellow
yellowgreen
orange
red
blue
grey
lightgrey
blueviolet
ff69b4

style

The style of the badge. Support flat, flat-square , plastic. Default is flat.

style demo
flat
flat-square
plastic

label

The label of the badge. Default is 'visitors'.

License

The scripts and documentation in this project are released under the MIT License