docs(readme): switch Quick Start to 'pip install aicertify' + add PyPI badges#58
Merged
Conversation
…I badges v0.7.0 is now live on PyPI (https://pypi.org/project/aicertify/0.7.0/), so the README's first instruction can be the single line everyone expects. ## Changes (applied to all 5 READMEs — English + zh-CN + ja-JP + ko-KR + hi-IN) ### Badges Added two new badges at the start of the badge row: - PyPI version (shields.io/pypi/v) - Total downloads (pepy.tech) Dropped the now-redundant hard-coded version-0.7.0 badge — the PyPI badge auto-updates on every release, which is what we want long-term. ### Quick Start Promoted pip install aicertify to the headline install instruction. Demoted the git-clone path to a follow-up step for running the bundled demo (which still needs the repo checked out for examples/quickstart.py), and added a separate "For development" / "開発用のセットアップ" / "개발용 설치" / "डेवलपमेंट के लिए" / "用于开发" section that keeps the `pip install -e .` editable-install path documented for contributors. All language switcher links + remaining badges + diagrams + every other README section is untouched. ## Verified - PyPI listing live: https://pypi.org/project/aicertify/0.7.0/ - Metadata complete on the live page: 16 keywords, 13+ classifiers, 6 project URLs (Homepage, Repository, Documentation, Issues, Changelog, Policy Library (gopal)), license Apache-2.0 - Both wheel + sdist uploaded and downloadable
github-actions
Bot
added
📝 documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
v0.7.0 is now live on PyPI: https://pypi.org/project/aicertify/0.7.0/.
This PR updates all five READMEs (English + zh-CN + ja-JP + ko-KR + hi-IN) so the first install instruction is the single line everyone expects:
Changes
Badge row
Quick Start
pip install aicertifyexamples/quickstart.py)pip install -e .editable-install path for contributorsTranslations all use locale-appropriate prose for the new sub-section headings ("用于开发" / "開発用のセットアップ" / "개발용 설치" / "डेवलपमेंट के लिए"). Diagrams, language switcher, comparison table, and every other section are untouched.
Verified
aicertify --helpworks;from aicertify import regulations, applicationworks