Summary

Adds comprehensive documentation for using custom Rego rules with poutine, addressing #255 which requested clarification on how to write and use custom rules at runtime.

Changes

• README.md: New "Custom Rules" section with configuration instructions, complete working example, and best practices
• .poutine.sample.yml: Enhanced with detailed comments and examples for the include directive

Example Usage

1. Create .poutine.yml:

include:
  - path: ./custom_rules

2. Write a custom rule in ./custom_rules/my_rule.rego:

package rules.my_custom_rule
import data.poutine
import rego.v1

rule := poutine.rule(rego.metadata.chain())
results contains poutine.finding(rule, pkg.purl, {...}) if { ... }

3. Run poutine:

poutine analyze_local .

Fixes #255

🤖 Generated with Claude Code