Skip to content

Commit

Permalink
README.md: Minor tweaks
Browse files Browse the repository at this point in the history
Insert a paragraph break before "Simple usage:".

Also, use "customized" instead of "extra" to describe the command line
options being passed in the advanced example. (With "extra" it reads
like the options are being appended to a list of existing - or default -
command line options, but in fact there are _no_ command line options
passed by default).
  • Loading branch information
jherland committed May 14, 2024
1 parent 317abf5 commit 4c83b23
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,15 @@ This action will run `fawltydeps` in the project directory for a Python codebase

## Example usage

You need to use a `checkout` action before
You need to use a `checkout` action before the FawltyDeps action.

Simple usage:

steps:
- uses: actions/checkout@v4
- uses: tweag/FawltyDeps-action@v0.0.2

More advanced example with extra command line options:
More advanced example with customized command line options:

steps:
- name: checkout
Expand Down

0 comments on commit 4c83b23

Please sign in to comment.