Skip to content

chore: discoverability pass — LICENSE, CHANGELOG, badges, screenshot, repo metadata - #30

Merged
killerwolf merged 3 commits into
mainfrom
chore/discoverability
Sep 7, 2026
Merged

chore: discoverability pass — LICENSE, CHANGELOG, badges, screenshot, repo metadata#30
killerwolf merged 3 commits into
mainfrom
chore/discoverability

Conversation

@killerwolf

Copy link
Copy Markdown
Owner

Surface-level polish so the repo reads as a maintained, usable project to someone who lands on it cold. No source changes — the app's behaviour is untouched.

Independent of #29; either can merge first.

LICENSE

Both the README and package.json claimed MIT, but no LICENSE file existed — so GitHub reported no licence at all, which reads as "legally do not touch this" to anyone evaluating it. Adds the file with the real copyright holder (2025–2026, from the first and latest commit years).

README

  • Badge row: latest release · total downloads · build status · licence. Downloads are the credibility number for a desktop app.
  • A screenshot of the app mid-session — the single highest-value element for an app with no registry page doing the explaining. Captured from the real app running against a sample folder.
  • Both images use absolute raw.githubusercontent.com URLs so they survive being rendered outside GitHub.
  • A pointer to the new CHANGELOG from the Download section.

Prose is otherwise unchanged.

CHANGELOG.md

All five GitHub releases were published with empty notes, so this reconstructs v0.9.0 → v1.4.0 from the commits between tags, written for the user rather than as a file-by-file log.

package.json

Field Before After
version 1.0.0 1.4.0 — CI rewrites it from the tag at build time, so the committed value had drifted four releases behind
homepage "./" the repo URL — "./" is a CRA convention; Vite reads base from vite.config.ts, so this field was doing nothing
author "QuickToss Team" the actual author
description the old "Tinder-like file organization tool" the README's opening sentence
repository, bugs, engines missing added (engines.node: >=20, matching CONTRIBUTING)

description now matches the README opener, the GitHub description and the social card, so the project describes itself the same way everywhere.

CI

release.yml only triggered on tags and pull requests, so main had zero runs — a CI badge would have rendered "no status". It now also runs on pushes to main. Tag pushes still gate the release job, so a main push runs lint/typecheck/test only.

Repo listing (already applied — not in this diff)

Description, homepage and 12 topics were all empty, making the repo close to unfindable by GitHub's own search. Set via the API.

Still manual

The 1280×640 social preview card is committed at .github/assets/social-preview.png, but GitHub only accepts a social preview through the web UI — it has to be uploaded by hand at Settings → Social preview → Edit.

🤖 Generated with Claude Code

killerwolf and others added 3 commits September 7, 2026 15:42
repository, bugs and engines were missing, homepage was still CRA's "./"
(Vite reads base from vite.config.ts, not this field), and the version
had drifted to 1.0.0 while releases were at 1.4.0 — CI rewrites it from
the tag at build time, so the committed value never caught up.

description now matches the README's opening sentence, which is also the
GitHub description and the social card's, so the project describes itself
the same way everywhere.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The workflow only triggered on tags and pull requests, so main had no runs
at all and a CI badge would have rendered "no status". Tag pushes still
gate the release job; main now runs lint, typecheck and tests only.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Both the README and package.json claimed MIT, but no LICENSE file existed,
so GitHub reported no licence and the repo read as "do not touch" to
anyone checking. Adds the file with the real copyright holder.

CHANGELOG.md reconstructs v0.9.0 through v1.4.0 from the commits between
tags, since the GitHub releases were published with empty notes.

The README gains a badge row and, more importantly, a screenshot of the
app mid-session — the thing that actually explains a desktop app. Both
images use absolute raw.githubusercontent URLs so they survive being
rendered outside GitHub. Prose is unchanged.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@killerwolf
killerwolf force-pushed the chore/discoverability branch from 3b76491 to d76d61a Compare September 7, 2026 13:43
@killerwolf
killerwolf merged commit 3a93afc into main Sep 7, 2026
2 checks passed
@killerwolf
killerwolf deleted the chore/discoverability branch September 7, 2026 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant