Skip to content

docs: clarify latest PyPI installation in README#300

Merged
GaodengLi merged 2 commits into
bytedance:mainfrom
LiuHuaize:codex/readme-pypi-install-note
Apr 23, 2026
Merged

docs: clarify latest PyPI installation in README#300
GaodengLi merged 2 commits into
bytedance:mainfrom
LiuHuaize:codex/readme-pypi-install-note

Conversation

@LiuHuaize
Copy link
Copy Markdown
Contributor

Summary

  • update the README install command to explicitly upgrade from the official PyPI index
  • add a short note explaining that lagging package mirrors can install an older CLI than the commands shown in the README

Why

Issue #224 reports that users can see CLI behavior that does not match the README after installing from PyPI. From the discussion, the README commands match , but stale package mirrors can still surface an older published package. This change makes the install step more explicit so users are more likely to get the latest release.

Fixes #224

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 10, 2026

CLA assistant check
All committers have signed the CLA.

@GaodengLi GaodengLi merged commit 3248f8e into bytedance:main Apr 23, 2026
2 checks passed
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.

README inacuracies

3 participants