Skip to content

docs: improve README with detailed usage and installation instructions - #55

Merged
kazeburo merged 3 commits into
masterfrom
feat/improve-readme
Aug 20, 2026
Merged

docs: improve README with detailed usage and installation instructions#55
kazeburo merged 3 commits into
masterfrom
feat/improve-readme

Conversation

@kazeburo

@kazeburo kazeburo commented Aug 20, 2026

Copy link
Copy Markdown
Member

PR Type

Documentation


Description

  • Expands README with Japanese usage guidance

  • Documents installation and agent configuration

  • Explains metrics, categories, and daemon architecture


Diagram Walkthrough

flowchart LR
  README["Expanded README"] -- "documents installation" --> Installation["Installation methods"]
  README -- "explains configuration" --> Configuration["Mackerel agent setup"]
  README -- "describes outputs" --> Metrics["Metrics and categories"]
  README -- "documents internals" --> Architecture["Daemon architecture"]
Loading

File Walkthrough

Relevant files
Documentation
README.md
Expand README installation and operational guidance           

README.md

  • Rewrites the introduction in Japanese with a clearer plugin overview.
  • Adds installation instructions for mkr and release binaries.
  • Documents command usage, agent configuration, metrics, categories, and
    meanings.
  • Explains daemon behavior, CPU statistics collection, history
    retention, and licensing.
+133/-15

@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit b51452e)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

Comment thread README.md Outdated
Comment thread README.md
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit fa79d7b

@github-actions

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

@sonarqubecloud

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit b51452e

Comment thread README.md
@kazeburo
kazeburo merged commit 56af45e into master Aug 20, 2026
3 checks passed
@kazeburo
kazeburo deleted the feat/improve-readme branch August 20, 2026 13:28
@github-actions github-actions Bot mentioned this pull request Aug 20, 2026
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.

1 participant