diff --git a/README.md b/README.md index 9b3d069..d9c2545 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,11 @@ # [Build](https://img.shields.io/github/actions/workflow/status/tweag/fawltydeps-action/ci.yaml) [![Code of conduct](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) -# FawltyDeps - -FawltyDeps is a dependency checker for Python that finds _undeclared_ and/or -_unused_ 3rd-party dependencies in your Python project. -The name is inspired by the Monty Python-adjacent -[Fawlty Towers](https://en.wikipedia.org/wiki/Fawlty_Towers) sitcom. - - +About [FawltyDeps](https://github.com/tweag/FawltyDeps): +> FawltyDeps is a dependency checker for Python that finds _undeclared_ and/or +> _unused_ 3rd-party dependencies in your Python project. +> The name is inspired by the Monty Python-adjacent +> [Fawlty Towers](https://en.wikipedia.org/wiki/Fawlty_Towers) sitcom. ## Table of contents @@ -26,8 +23,6 @@ The name is inspired by the Monty Python-adjacent [Example usage](#example%20usage) -[Configuration](#configuration) - [Documentation](#documentation) [Development](#development) @@ -38,35 +33,29 @@ This allows you to run FawltyDeps as part of an independent GitHub action. ## Usage -This action prints "Hello World" or "Hello" + the name of a person to greet to the log. +This action will run `fawltydeps` in the project directory for a Python codebase. See the [FawltyDeps - Configuration](https://github.com/tweag/FawltyDeps?tab=readme-ov-file#configuration) documentation for more on how to configure this tool. ## Inputs -## `who-to-greet` - -**Required** The name of the person to greet. Default `"World"`. - -## Outputs +### `options` -## `time` - -The time we greeted you. +**Optional** command line arguments to `fawltydeps`. ## Example usage -uses: actions/hello-world-docker-action@v2 -with: - who-to-greet: 'Mona the Octocat' +Simple usage: + uses: tweag/FawltyDeps-action@v0.0.1 -## Configuration +More advanced example with extra command line options: -TODO: describe plugin configuration + uses: tweag/FawltyDeps-action@v0.0.1 + with: + options: --list-sources --list-imports --list-deps --detailed ## Documentation -TODO: provide more docs on design of action - +This action was inspired by the [black]() and [isort-action]() GitHub actions. It currently uses the Docker method of executing actions. ## Development @@ -74,11 +63,3 @@ For details on setting up your development environment, please refer to the contributing guidelines of how to [set up your development environment](./CONTRIBUTING.md#set-up-your-development-environment) in our [CONTRIBUTING.md](CONTRIBUTING.md) file. -## Integration tests - -For details on integration tests, please refer to the -[Testing section](./CONTRIBUTING.md#testing) in our [CONTRIBUTING.md](./CONTRIBUTING.md) file. - -## FAQ - -### TODO: write FAQ entries