docs: update

This commit is contained in:
iff 2025-01-07 01:52:35 +01:00
parent 5b98d3badc
commit 195aa34f95
3 changed files with 12 additions and 1 deletions

View file

@ -38,6 +38,13 @@ Your module should print:
- At the end of each suggestion, append `<_PR_BR>` so pay-respects knows you are either done or adding another suggestion
- **To `stderr`**: Any relevant information that should display to the user (e.g, warning for AI generated content)
An example of a shell based module that always adds a `sudo` before the command:
```sh
#!/bin/sh
echo "sudo $_PR_LAST_COMMAND"
echo "<_PR_BR>"
```
## Adding a Module
Expose your module as executable (`chmod u+x`) in `PATH`, and done!