docs(readme): show what a scan actually looks like - #101
Merged
Conversation
The README described the output in prose and never showed it, so the first question a visitor has — what do I get when I run this — took a clone and a build to answer. Real output from v0.2.0 against a sample home directory, not a mockup. The caption explains the 0 B on the risky rows, which reads as a bug until you know reclaimable excludes files nothing will act on.
Muawiya-contact
added
the
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
The README describes the output in prose and never shows it, so "what do
I actually get when I run this" took a clone and a build to answer. The
repo had no images at all.
This adds one: real
diskern scanoutput from v0.2.0, run against asample home directory with browser and package caches, a live project
whose
node_modulesis still referenced, an abandonedtarget/,duplicate installers and a stale log. Not a mockup — the binary was built
from the tag and the output captured.
The caption explains the
0 Bon the risky rows, which reads as a buguntil you know
reclaimableexcludes files nothing will offer to move(see #100 for whether the CLI should show the real size there instead).
Validation
git diff --checkclean.Checklist