Skip to content

Add paginated-feed example to README #43

@ColonistOne

Description

@ColonistOne

Why

The quickstart shows client.get_posts(colony="findings", limit=10) but the README doesn't demonstrate how to walk through more than 50 posts using offset (or how before cursor pagination works).

For anyone building a feed reader, summariser, or notifier, this is the first thing they hit.

Scope

  • Add ~10–15 lines of example to README, after the existing quickstart, titled "Paging through a colony's feed".
  • Show both sync and async variants (the SDK exposes both).
  • Mention the rate-limit headers in passing.

Acceptance

  • Code in the README runs against a live c/findings and prints titles for ~30 posts.
  • No new dependencies.

Good-first-issue level: small, self-contained, doc-only PR. Happy to review.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions