Skip to content

docs(readme): quickstart clones the repo (no 'conformance' PyPI trap) + badges - #3

Merged
logickeau merged 1 commit into
mainfrom
docs/quickstart-clone-badges
Oct 16, 2026
Merged

logickeau merged 1 commit into
mainfrom
docs/quickstart-clone-badges

Conversation

@logickeau

Copy link
Copy Markdown
Contributor

The quickstart showed:

pip install vitnify
python -m conformance

with no clone step. python -m conformance runs from this repo — there is no conformance package on PyPI, so a user following the quickstart literally either fails or (worse) pip install conformance grabs an unrelated stranger's package. Fixed to show git clone … && cd conformance, with an explicit note that no conformance PyPI package is required. Also adds CI + license badges.

The quickstart showed 'pip install vitnify; python -m conformance' with no clone step.
python -m conformance runs from THIS repo -- there is no 'conformance' package on PyPI
(installing one would grab an unrelated stranger's package). Show the git clone + cd,
and note explicitly that no 'conformance' PyPI package is needed. Add CI + license badges.
@logickeau
logickeau merged commit e7644ac into main Oct 16, 2026
5 checks passed
@logickeau
logickeau deleted the docs/quickstart-clone-badges branch October 16, 2026 23:29
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