Skip to content

horizon-listener README doesn't document createWebhookForwarder #263

Description

@Idaonoli

Problem

createWebhookForwarder (horizon-listener/src/factory.ts) — a one-call factory combining RpcEventSource, HttpWebhookSender, and HorizonListener — is exported from the package's public API but never mentioned in horizon-listener/README.md, which instead only shows the three pieces wired together manually.

Why it matters

This is exactly the kind of convenience API a README should lead with for the common case; without documentation, users are more likely to hand-wire the three pieces themselves (as the README currently shows) even though a simpler option exists.

Suggested approach

Add the factory as the primary "quick start" example in the README, keeping the manual wiring example further down for cases needing more control.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions