Skip to content

docs: simplify README quick start usage#6

Merged
gjkim42 merged 1 commit into
mainfrom
kanon-task-5
May 30, 2026
Merged

docs: simplify README quick start usage#6
gjkim42 merged 1 commit into
mainfrom
kanon-task-5

Conversation

@kelos-bot
Copy link
Copy Markdown

@kelos-bot kelos-bot Bot commented May 30, 2026

Summary

The README quick start passed --home ~/.config/kanon on every command, but ~/.config/kanon is already the default Kanon home (KANON_HOME or --home override it). Repeating the flag added noise without adding meaning.

This simplifies the quick-start examples to the minimal form and moves the default-path explanation into the surrounding prose.

kanon init
kanon validate
kanon diff
kanon apply

Testing

  • make verify

Closes #5

🤖 Generated with Claude Code

The Kanon home defaults to ~/.config/kanon, so passing
--home ~/.config/kanon on every quick-start command is redundant.
Drop it and clarify the default in the surrounding prose.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@kelos-bot
Copy link
Copy Markdown
Author

kelos-bot Bot commented May 30, 2026

/kelos review

@kelos-bot kelos-bot Bot mentioned this pull request May 30, 2026
@gjkim42 gjkim42 merged commit 5a31eb7 into main May 30, 2026
4 checks passed
@gjkim42 gjkim42 deleted the kanon-task-5 branch May 30, 2026 05:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

simplify usage of README.md

1 participant