From 7335bfef89c07b8163137f759ca6bf2944c5c4c5 Mon Sep 17 00:00:00 2001 From: logickeau Date: Fri, 16 Oct 2026 19:28:05 -0400 Subject: [PATCH] docs(readme): quickstart must clone the repo; add 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. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8324854..c8e35d6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # vitnify/conformance +[![CI](https://github.com/vitnify/conformance/actions/workflows/ci.yml/badge.svg)](https://github.com/vitnify/conformance/actions/workflows/ci.yml) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) + **The executable definition of a conformant vitnify receipt.** Point it at an implementation; it tells you whether that implementation reproduces the reference vectors and rejects the forgeries. @@ -11,8 +14,9 @@ both the way this kit specifies — so a receipt one tool issues means the same to a tool built by someone else. This repo is that specification, in runnable form. ``` -pip install vitnify -python -m conformance +git clone https://github.com/vitnify/conformance && cd conformance +pip install vitnify # the reference implementation under test (from PyPI) +python -m conformance # runs from this repo; there is no 'conformance' PyPI package ``` ```