Repository navigation
docs: README and full changelog for the 1.0.0 release - #545
Merged
Merged
Conversation
The README still read as a list of parts. It now leads with the new direction: Claude Code's defaults do most of the work, and Blacksmith adds only what they leave out. The changelog gains upgrade steps, the full list of what was added, changed and removed, what merged after 0.7.0 without being published, and a short table for 0.x. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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 changed and why
The maintainer asked for a README in the new direction and a 1.0.0 release with a full changelog. The README was a bare list of parts. It now leads with the direction: Claude Code's defaults do most of the work, and Blacksmith adds only what they leave out. It says what you notice from each rule, what the two commands do, what leaves your machine, why the project got small, and what to do when coming from 0.x.
CHANGELOG.mdgains upgrade steps, the full added, changed and removed lists, what merged after 0.7.0 without being published, and a short table for 0.x with a link to the old 4,200-line text atfactory-final.docs/usage.mdnow names the verify rule, anddocs/history.mdsays thatfactory-finalis more than 0.7.0 and that the npm package is deprecated.Docs only. No plugin file changes, and
plugin.jsonalready says 1.0.0.What I actually ran
No SKIP or FAIL lines. A fresh-context reviewer checked every claim against the code, git history, tags and PR numbers and found no factual defect. It raised the existing credit line for ayghri/i-have-adhd, which stays: it is an MIT attribution that was already in the README.
bash scripts/check.shis green on this branchCHANGELOG.mdhas an entry, under 1.0.0 rather than Unreleased, since this is the release🤖 Generated with Claude Code