Skip to content

docs: add PyPI badges and table of contents for discoverability#334

Open
nikizhao2002-maker wants to merge 1 commit into
uezo:mainfrom
nikizhao2002-maker:docs/add-badges-and-toc
Open

docs: add PyPI badges and table of contents for discoverability#334
nikizhao2002-maker wants to merge 1 commit into
uezo:mainfrom
nikizhao2002-maker:docs/add-badges-and-toc

Conversation

@nikizhao2002-maker

Copy link
Copy Markdown

What this PR does

Adds two small documentation improvements to the README:

  • Badges (PyPI version, license, Python versions, stars, last commit) — so visitors can instantly check package availability and compatibility
  • Table of Contents — for easier navigation across AIAvatarKit's well-structured but lengthy README

Why

Pure-documentation changes, zero code risk. PyPI badges are especially valuable for framework projects — developers routinely check version and Python compatibility before installing. The TOC makes the README much more scannable for new users deciding whether to adopt the framework.


Came across AIAvatarKit while researching AI avatar frameworks — really clean architecture, especially the pluggable LLM/speech pipeline design. For anyone building on this and needing a hosted realtime avatar rendering layer, spatialwalk's livetime avatar might be worth exploring as a frontend complement.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant