Merge pull request #6 from tweag/fixup-minor-issues

Expand docs more

README.md

@@ -44,23 +44,35 @@ This action will run `fawltydeps` in the project directory for a Python codebase
 
 You need to use a `checkout` action before the FawltyDeps action.
 
-Simple usage:
+For simple usage, save this in your project as `.github/workflows/lint.yml`:
 
-    steps:
-      - uses: actions/checkout@v4
-      - uses: tweag/[email protected]
+```yaml
+---
+name: Lint
 
-More advanced example with customized command line options:
+on: pull_request
 
+jobs:
+  lint:
+    name: FawltyDeps
+    runs-on: ubuntu-latest
     steps:
       - name: checkout
         uses: actions/checkout@v4
-      - name: fawltydeps lint
-        uses: tweag/[email protected]
+      - name: lint - FawltyDeps
+        uses: tweag/[email protected]
+```
+
+Here is a more advanced example with customized command line options:
+
+```yaml
+      - name: lint - FawltyDeps
+        uses: tweag/[email protected]
         with:
-          options: --list-sources --list-imports --list-deps --detailed
+          options: --detailed --exclude vendor/
+```
 
-Invoking FawltyDeps Using `options: --detailed` yields good results when you just want to see what problems may be present.
+Invoking FawltyDeps using `options: --detailed` yields good results when you just want to see what problems may be present. That is now the _default_, if you do not specify any options. You can also configure FawltyDeps through the `[tool.fawltydeps]` section in your project's `pyproject.toml` file, see [Configuration](https://github.com/tweag/FawltyDeps#configuration] in the main FawltyDeps documentation for more details.
 
 ## Documentation