docs: add README badges and config show mention - #3
Merged
Conversation
Add CI, CodeQL, GitHub Advanced Security, and npm publish workflow badges, plus npm version, MIT license, open issues, DeepWiki, and Code Wiki badges. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Document that ppv-cli config show prints the config file path and the current settings (token masked), both in the Configuration section and in the ppv-cli command examples. - Reorder the Quick start exploration examples to lead with the interactive tools and show a single work instead of a list. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the project README to improve repository visibility (status/info badges) and to clarify how users can locate and inspect the CLI’s configuration via ppv-cli config show.
Changes:
- Adds multiple badges (CI, npm version, license, issues, DeepWiki, Code Wiki) near the top of the README.
- Documents
ppv-cli config showas the way to print the config file path and current settings (with token masked) and adds it to usage examples. - Adjusts the “Quick start” exploration examples to lead with the interactive tools.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+3
to
+5
| [](https://github.com/F88/ppv26-cli/actions/workflows/ci.yml) | ||
| [](https://github.com/F88/ppv26-cli/actions/workflows/github-code-scanning/codeql) | ||
| [](https://github.com/F88/ppv26-cli/actions/workflows/agents/github-advanced-security) |
|  | ||
|
|
||
| [](https://deepwiki.com/F88/ppv26-cli) | ||
| [](https://codewiki.google/github.com/f88/ppv26-cli) |
Copy-paste-ready Japanese material for introducing the tools, aligned with the ProtoPedia entry fields (title, summary, story). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Rework the Story draft into a motivation-first narrative within the 2000-character limit, add environment requirements and a quick guide, and restore the material/tag/image sections for the entry form. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Lead the story with the motivation, restructure the sections (overview, three tools, requirements, quick guide), and rewrite in a more personal voice. Co-Authored-By: Claude Fable 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.
Summary
ppv-cli config showas the way to locate the config file and inspect current settings (token masked), in both the Configuration section and the ppv-cli examplesNote: the "Publish package to npmjs.com" badge currently shows failing; the last run was an intentional connectivity check and the badge will turn green with the next release.
🤖 Generated with Claude Code