Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikhail Epatko committed Mar 24, 2024
1 parent 1b4bf08 commit 7dafb19
Showing 1 changed file with 29 additions and 20 deletions.
49 changes: 29 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,35 @@ a .github/workflows/main.yml file in your repository
on: [push]

jobs:
lines_counter_job:
runs-on: ubuntu-latest
name: A job to count hits of code
steps:
- uses: actions/checkout@v4
- id: badge-generator
uses: ./ # Write the action name instead.
with:
since: 2000-01-01 # Default value: '2000-01-01'.
before: 2024-03-03' # Default value: now day.
dir: . # Default value: include all files in the current directory.
# For exclude option we can use multiline strings if we want to pass multiple values.
# In this case it's an important detail that we used '|' or '|-' in the YAML.
# There is no default value for exclude option.
exclude: |
dir1/**
dir2/**/*
dir3/file.txt
output_dir: ./output # Default value: './output'.
filename: hoc-badge.svg # Default value: 'hoc-badge.svg'.
lines_counter_job:
runs-on: ubuntu-latest
name: A job to count hits of code
steps:
- uses: actions/checkout@v4
- id: badge-generator
uses: ./ # Write the action name instead.
with:
since: 2000-01-01 # Default value: '2000-01-01'.
before: 2024-03-03' # Default value: now day.
dir: . # Default value: include all files in the current directory.
# For exclude option we can use multiline strings if we want to pass multiple values.
# In this case it's an important detail that we used '|' or '|-' in the YAML.
# There is no default value for exclude option.
exclude: |
dir1/**
dir2/**/*
dir3/file.txt
output_dir: ./output # Default value: './output'.
filename: hoc-badge.svg # Default value: 'hoc-badge.svg'
# Rounding mode:
# I - integers (default)
# K - up to thousands
# M - up to millions
# G - up to billions
rounding:
description: 'Rounding mode. Default: I'
required: false
default: 'I'
```

The badge will be generated into the file ./output/hoc-badge.svg by default.
Expand Down

0 comments on commit 7dafb19

Please sign in to comment.