Skip to content

Add a 30-second demo to the README #12

@ayhammouda

Description

@ayhammouda

Why

People do not star abstract infrastructure. They star tools they understand in seconds. The repo needs a short, concrete demo showing the value over generic docs retrieval.

Suggested demo query

Use one or both:

  • asyncio.TaskGroup
  • typing.TypeAliasType

Acceptance criteria

  • README contains a short demo section near the top.
  • Demo shows the prompt, tool flow/result, and why the answer is better than a full-page docs dump.
  • Optional but ideal: include a GIF or terminal recording.
  • Demo is reproducible with the published install path.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority:P1High priority

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions