Problem
The README covers local installation and basic usage, but gives no guidance on how to use rocale-cli in a CI environment. The devforum announcement explicitly calls out CI pipelines as a primary use case:
"Managing a large repo? Run automated tests and verification in your team's CI pipelines on GitHub Actions and beyond."
New adopters have no example to follow.
Proposed solution
Add a "CI usage" section to the README with a GitHub Actions example. The repo already has a working CI workflow in .github/workflows/ that can serve as the basis so this is purely a docs change, no new functionality needed.
Why this matters
A CI example in the README removes the biggest friction point for new users wanting to utilise it in production workflows. It also makes the "CI pipelines" use case from the devforum announcement actually actionable for developers reading the docs for the first time.
Problem
The README covers local installation and basic usage, but gives no guidance on how to use rocale-cli in a CI environment. The devforum announcement explicitly calls out CI pipelines as a primary use case:
New adopters have no example to follow.
Proposed solution
Add a "CI usage" section to the README with a GitHub Actions example. The repo already has a working CI workflow in
.github/workflows/that can serve as the basis so this is purely a docs change, no new functionality needed.Why this matters
A CI example in the README removes the biggest friction point for new users wanting to utilise it in production workflows. It also makes the "CI pipelines" use case from the devforum announcement actually actionable for developers reading the docs for the first time.