Skip to content

Update README with setup guide, providers, and examples #7

@nev-offload

Description

@nev-offload

Problem

The README needs to be updated to reflect the current state of the project, including OpenRouter support and all supported providers.

Content needed

  1. Quick start guide — minimal steps to get the action running
  2. Supported providers — list all 8 providers with example model strings
  3. Configuration reference — all inputs, secrets, and environment variables
  4. Trigger examples — workflow YAML for each supported trigger type:
    • Issue opened
    • PR opened
    • Comment mention
    • Scheduled cron
    • Manual dispatch
  5. OpenRouter setup — specific instructions for using OpenRouter (free models!)
  6. .openclaw.yml config — document the repo config file format (once implemented)
  7. Architecture diagram — how the action connects to the gateway
  8. Troubleshooting — common errors and fixes

Priority

P2 — Important for adoption but not blocking development.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions