docs(readme): pip install codebase-index from PyPI#20
Conversation
PyPI is live as of 1.6.0, so make `pip install codebase-index` the primary install (Option 1); keep the pinned git+tag installs as alternatives for reproducible/unreleased installs. Update Project Status + distribution roadmap. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3a4d564ce3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| For most users, install the package from PyPI and run `init` inside the | ||
| repository you want to index: | ||
|
|
||
| ```bash | ||
| pip install "codebase-index @ git+https://github.com/denfry/codebase-index.git@v1.6.0" | ||
| pip install codebase-index # or: pipx install codebase-index |
There was a problem hiding this comment.
Update the linked installation guide too
This makes PyPI the primary install path in the README, but the linked full guide still tells users the opposite (docs/INSTALLATION.md:5-7 says the package is not on PyPI, and docs/INSTALLATION.md:92-96 keeps PyPI/pipx in the future roadmap). Users who follow the README’s install section to the installation guide will get contradictory commands, so the guide should be updated in the same change or this primary recommendation should remain on the GitHub-tag path.
Useful? React with 👍 / 👎.
Now that v1.6.0 is on PyPI, the README leads with
pip install codebase-index.pip install codebase-index.pip/pipx); the git+tag installs become Option 2/3 for pinning to an exact version or an unreleased commit.uvx/Homebrew still planned).Docs-only; no code change.
🤖 Generated with Claude Code