Skip to content

chore(docs): updated readme #432

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
Chrilleweb merged 1 commit into from
May 31, 2026
Merged

chore(docs): updated readme #432

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
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,8 @@ First-class support for SvelteKit and Next.js. Also works well in modern JavaScr

---

### Warnings & errors detection

![Demo](./docs/assets/demo.gif)

### Clean / successful scan

![Successful Scan](./docs/assets/success.png)

---

## Why dotenv-diff?
Expand Down Expand Up @@ -98,6 +92,18 @@ API_TOKEN=

---

## Suppress existing warnings (`--baseline`)

Adopt dotenv-diff in projects that already have known warnings by recording the current state into a baseline file. Future runs will only report newly introduced issues:

```bash
dotenv-diff --baseline
```

→ See [Baseline Documentation](./docs/baseline.md) for more details.

---

## Explain a variable (`--explain`)

Inspect a specific environment variable to see where it is defined, where it is used in the codebase, and its overall status:
Expand Down
18 changes: 12 additions & 6 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,8 @@ First-class support for SvelteKit and Next.js. Also works well in modern JavaScr

---

### Warnings & errors detection

![Demo](https://raw.githubusercontent.com/Chrilleweb/dotenv-diff/main/docs/assets/demo.gif)

### Clean / successful scan

![Successful Scan](https://raw.githubusercontent.com/Chrilleweb/dotenv-diff/main/docs/assets/success.png)

---

## Why dotenv-diff?
Expand Down Expand Up @@ -98,6 +92,18 @@ API_TOKEN=

---

---

## Suppress existing warnings (`--baseline`)

Adopt dotenv-diff in projects that already have known warnings by recording the current state into a baseline file. Future runs will only report newly introduced issues:

```bash
dotenv-diff --baseline
```

→ See [Baseline Documentation](https://github.com/Chrilleweb/dotenv-diff/blob/main/docs/baseline.md) for more details.

## Explain a variable (`--explain`)

Inspect a specific environment variable to see where it is defined, where it is used in the codebase, and its overall status:
Expand Down