Skip to content

fix(readme): sync PyPI README #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 17, 2025
Merged

fix(readme): sync PyPI README #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f5ba976
docs(readme): sync badges + examples for PyPI render
CoderDeltaLAN Sep 17, 2025
46a1dfe
fix(readme): sync PyPI README (badges + examples)
CoderDeltaLAN Sep 17, 2025
84334bc
fix(readme): resolve merge with main
CoderDeltaLAN Sep 17, 2025
ed69ceb
chore(ci): retrigger checks for PR #87
CoderDeltaLAN Sep 17, 2025
7411813
chore(ci): trigger checks for PR #87
CoderDeltaLAN Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Designed for clean CI; use the JSON output to enforce your own merge gates in wo
[![Release](https://img.shields.io/github/v/release/CoderDeltaLAN/diff-risk-dashboard?display_name=tag)](https://github.com/CoderDeltaLAN/diff-risk-dashboard/releases)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![GHCR](https://img.shields.io/badge/container-ghcr.io-blue)](../../pkgs/container/diff-risk-dashboard)
[![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)
[![Donate - PayPal](https://img.shields.io/badge/Donate-PayPal-0070ba?logo=paypal&logoColor=white)](https://www.paypal.com/donate/?hosted_button_id=YVENCBNCZWVPW)

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

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

### Install & run locally
### A) Install & run locally

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

### Install & Run

#### B) From PyPI (recomendado)

```bash
python -m pip install -U pip
python -m pip install diff-risk-dashboard

# Use the CLI
diff-risk examples/sample_apv.json -f md -o report.md
diff-risk examples/sample_apv.json -f json -o report.json
```

### CLI usage

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

---

<!-- sync: 2025-09-17T06:38:28Z -->
Empty file added src/.ci_trigger_1758091764
View file
Open in desktop
Empty file.
Loading