Skip to content

Commit 46a1dfe

Browse files
committed
fix(readme): sync PyPI README (badges + examples)
1 parent f5ba976 commit 46a1dfe

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Designed for clean CI; use the JSON output to enforce your own merge gates in wo
1414
[![Release](https://img.shields.io/github/v/release/CoderDeltaLAN/diff-risk-dashboard?display_name=tag)](https://github.com/CoderDeltaLAN/diff-risk-dashboard/releases)
1515
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
1616
[![GHCR](https://img.shields.io/badge/container-ghcr.io-blue)](../../pkgs/container/diff-risk-dashboard)
17-
[![Repo views](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FCoderDeltaLAN%2Fdiff-risk-dashboard&count_bg=%230070BA&title_bg=%23000000&icon=github.svg&icon_color=%23FFFFFF&title=views&edge_flat=true)](https://hits.seeyoufarm.com)
1817
[![Donate - PayPal](https://img.shields.io/badge/Donate-PayPal-0070ba?logo=paypal&logoColor=white)](https://www.paypal.com/donate/?hosted_button_id=YVENCBNCZWVPW)
1918

2019
</div>
@@ -59,7 +58,7 @@ diff-risk examples/sample_apv.json -f md -o -
5958

6059
<!-- diff-risk:usage:end -->
6160

62-
### Install & run locally
61+
### A) Install & run locally
6362

6463
```bash
6564
# 1) Clone
@@ -74,6 +73,19 @@ python -m pip install .
7473
diff-risk examples/sample_apv.json -f md -o report.md
7574
```
7675

76+
### Install & Run
77+
78+
#### B) From PyPI (recomendado)
79+
80+
```bash
81+
python -m pip install -U pip
82+
python -m pip install diff-risk-dashboard
83+
84+
# Use the CLI
85+
diff-risk examples/sample_apv.json -f md -o report.md
86+
diff-risk examples/sample_apv.json -f json -o report.json
87+
```
88+
7789
### CLI usage
7890

7991
```text
@@ -198,3 +210,5 @@ Support open-source: your donations keep projects clean, secure, and evolving fo
198210
Released under the **MIT License**. See [LICENSE](LICENSE).
199211

200212
---
213+
214+
<!-- sync: 2025-09-17T06:38:28Z -->

0 commit comments

Comments
 (0)