docs: rewrite READMEs for clarity and GitHub best practices#25
Merged
Conversation
Restructure both README.md and README.ja.md to follow the recommended GitHub README format: what the project does, why it is useful, key features, getting started, how it works, and configuration. Key changes: - Add version 0.2.0 badge - Replace detailed pipeline diagram with concise hook-by-hook overview - Simplify setup instructions and prerequisites - Consolidate note lifecycle and vault output sections - Improve contribution guidelines with explicit expectations - Align Japanese README with English content Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
masuda-so
added a commit
that referenced
this pull request
May 10, 2026
Restructure both README.md and README.ja.md to follow the recommended GitHub README format: what the project does, why it is useful, key features, getting started, how it works, and configuration. Key changes: - Add version 0.2.0 badge - Replace detailed pipeline diagram with concise hook-by-hook overview - Simplify setup instructions and prerequisites - Consolidate note lifecycle and vault output sections - Improve contribution guidelines with explicit expectations - Align Japanese README with English content Co-authored-by: Claude Opus 4.6 <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
1 participant
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.
Summary
Test plan