Skip to content

Commit

Permalink
Improve docs more
Browse files Browse the repository at this point in the history
  • Loading branch information
obscurerichard committed May 10, 2024
1 parent ce8ce02 commit 02ecd0c
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,22 @@ This action will run `fawltydeps` in the project directory for a Python codebase

## Example usage

You need to use a `checkout` action before
Simple usage:

uses: tweag/[email protected]
steps:
- uses: actions/checkout@v4
- uses: tweag/[email protected]

More advanced example with extra command line options:

uses: tweag/[email protected]
with:
options: --list-sources --list-imports --list-deps --detailed
steps:
- name: checkout
uses: actions/checkout@v4
- name: fawltydeps lint
uses: tweag/[email protected]
with:
options: --list-sources --list-imports --list-deps --detailed

## Documentation

Expand Down

0 comments on commit 02ecd0c

Please sign in to comment.