Skip to content

Rewrite README in a more natural voice - #2

Merged
SultanZhalifa merged 1 commit into
masterfrom
claude/strange-payne-04496b
May 9, 2026
Merged

SultanZhalifa merged 1 commit into
masterfrom
claude/strange-payne-04496b

Conversation

@SultanZhalifa

Copy link
Copy Markdown
Owner

Drops the AI-flavored decoration: emoji headers, em-dashes, "portfolio-grade", "showcase", "polished", section dividers between every heading. Reframes the intro around how the project actually started (Java prototype for class, then rewritten) so the tone reads like a developer note rather than marketing.

Also adds a "Notes on a few decisions" section with the small tradeoffs I had to actually think about: why hand-rolled JSON, why HttpURLConnection over OkHttp, why ServiceLocator over Hilt, why salted SHA-256 instead of a KDF, why exportSchema is off. These are the things I'd talk through in an interview, so they belong in the README.

Content-wise, the feature list, architecture diagram, tech stack, project layout, test inventory, roadmap, and download section are all preserved.

Drops the AI-flavored decoration: emoji headers, em-dashes, "portfolio-grade",
"showcase", "polished", section dividers between every heading. Reframes the
intro around how the project actually started (Java prototype for class, then
rewritten) so the tone reads like a developer note rather than marketing.

Also adds a "Notes on a few decisions" section with the small tradeoffs I had
to actually think about: why hand-rolled JSON, why HttpURLConnection over
OkHttp, why ServiceLocator over Hilt, why salted SHA-256 instead of a KDF,
why exportSchema is off. These are the things I'd talk through in an
interview, so they belong in the README.

Content-wise, the feature list, architecture diagram, tech stack, project
layout, test inventory, roadmap, and download section are all preserved.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@SultanZhalifa
SultanZhalifa merged commit f4cab6e into master May 9, 2026
1 check passed
@SultanZhalifa
SultanZhalifa deleted the claude/strange-payne-04496b branch May 9, 2026 19:02
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