Skip to content

docs: Tighten readme #152

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
sonukapoor merged 1 commit into from
Apr 11, 2026
Merged

docs: Tighten readme #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
<img src="https://raw.githubusercontent.com/sonukapoor/cve-lite-cli/main/assets/logo-with-title.png" alt="CVE Lite CLI" width="320"/>

<h1>CVE Lite CLI</h1>
<p>Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript projects, with offline support for restricted environments.</p>
<p>Fast, developer-friendly vulnerability scanning for JavaScript and TypeScript projects, with practical fix guidance, offline support, and clear direct vs transitive visibility.</p>

<strong>Scan. Prioritize. Fix.</strong>
<strong>Scan. Understand. Fix.</strong>

<p>
<a href="#quick-start">Quick Start</a> •
Expand Down Expand Up @@ -73,7 +73,7 @@

## What is CVE Lite CLI

**CVE Lite CLI** helps developers scan their projects for known package vulnerabilities without signing up for an expensive platform. It is built for the moment right before release, when you want a clear answer, a practical fix plan, and a tool you can actually afford to use.
**CVE Lite CLI** helps developers scan JavaScript and TypeScript projects for known dependency vulnerabilities and, more importantly, see what to fix first. It is built for the moment right before release, when you want a clear answer, a practical remediation path, and a tool you can run locally without platform overhead.

It is designed to be:

Expand Down Expand Up @@ -262,7 +262,7 @@ cve-lite /path/to/project --offline

## What it looks like

CVE Lite CLI produces a clean, summary-first console view by default, designed for fast triage before release.
CVE Lite CLI produces a summary-first console view designed for fast release triage. Its most useful differentiator is the Copy And Run These Fix Commands section, which turns findings into concrete next steps for direct dependencies while still surfacing parent-upgrade guidance for transitive issues when available.

The default output is designed to stay concise while still surfacing the most important next step, including package-manager-aware fix commands when confident targets exist.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<span class="release-badge-version">v1.5.2</span>
</a>
<p class="eyebrow">JavaScript/TypeScript Dependency Scanner</p>
<h1>Scan. Prioritize. Fix.</h1>
<h1>Scan. Understand. Fix.</h1>
<p>
CVE Lite CLI gives you a fast, local-first vulnerability scan with practical remediation commands, direct vs transitive
clarity, and offline advisory DB support for restricted environments, so dependency fixes happen in minutes instead of
Expand Down
Loading