Skip to content

Improve README with quick start examples and badges #3

@azrollin

Description

@azrollin

The README needs:

  • Badges (PyPI version, license, tests passing, Python versions)
  • Quick "Try it in 2 minutes" section with copy-paste examples
  • GIF or screenshot showing a scan in action
  • Architecture overview diagram

Any of these individually would be a great first contribution.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions