Skip to content

Update README and add template placeholder comments#1097

Merged
threeal merged 1 commit into
mainfrom
update-readme
Jun 3, 2026
Merged

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

Conversation

@threeal
Copy link
Copy Markdown
Owner

@threeal threeal commented May 20, 2026

Summary

Rewrites README.md with a cleaner structure and more useful content for template users:

  • Replaces the generic intro with a focused description of what the template provides
  • Splits the old numbered "Getting Started" into a top-level quick-start blurb ("Getting Started") and a dedicated "Setup" section with explicit shell commands for pnpm install and lefthook install
  • Rewrites "Customizing" to use bold headings per file/folder with more precise descriptions, and drops config files that users rarely need to touch
  • Adds a "Development" section explaining how to use the pre-commit hook day-to-day
  • Adds a "Testing" section with the pnpm vitest run command and a note about 100% coverage enforcement
  • Adds a "CI" section describing what the workflow does
  • Adds a "Releasing" section covering version bumping, tagging, and pnpm publish
  • Adds a "Framework-Specific Templates" section linking to related starters (Action Starter, Discord Bot Starter)

@threeal threeal self-assigned this May 20, 2026
@threeal threeal added the documentation Improvements or additions to documentation label May 20, 2026
@threeal threeal marked this pull request as draft May 26, 2026 09:50
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>
@threeal threeal marked this pull request as ready for review June 3, 2026 08:35
@threeal threeal added this to the Version 4.1.0 milestone Jun 3, 2026
@threeal threeal merged commit 7be0ca2 into main Jun 3, 2026
1 check passed
@threeal threeal deleted the update-readme branch June 3, 2026 08:38
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