Skip to content

Update README and add template placeholder comments#1097

Open
threeal wants to merge 1 commit into
mainfrom
update-readme
Open

Update README and add template placeholder comments#1097
threeal wants to merge 1 commit into
mainfrom
update-readme

Conversation

@threeal
Copy link
Copy Markdown
Owner

@threeal threeal commented May 20, 2026

Summary

  • Rewrites README with a cleaner structure: concise feature list and numbered getting started steps covering project creation through release
  • Adds template placeholder comments to src/lib.ts, src/bin.ts, and their test files to guide users when replacing the placeholder code
  • Updates CLAUDE.md to clarify that Lefthook is optional and only needed to enable pre-commit hooks

Test plan

  • Review README renders correctly on GitHub
  • Verify placeholder comments appear at the top of each source file

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>
@threeal threeal self-assigned this May 20, 2026
@threeal threeal added the documentation Improvements or additions to documentation label May 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant