improve readme

[kazeburo]

PR Type

Documentation

---

Description

• Rewrite and expand README.md project documentation

• Add dedicated Installation and Options sections

• Reorganize Usage with basic, first-run, and diff examples

• Add Mackerel configuration and License sections

---

Diagram Walkthrough

flowchart LR
  A["Old README"] -- "Expand description" --> B["Project overview"]
  A -- "Add install steps" --> C["Installation section"]
  A -- "Restructure examples" --> D["Usage subsections"]
  A -- "Document flags" --> E["Options section"]
  A -- "Add config example" --> F["Mackerel configuration"]

Loading

File Walkthrough

Relevant files

Documentation

README.md Expand and restructure README documentation                            README.md Rewrite opening description and add links to Mackerel and diff-detector Add Installation section with release binary and mkr plugin install instructions Restructure Usage into Basic usage, First run, and Detecting differences subsections Add Options section documenting -w/--warn, --identifier, --workdir, and -v/--version Rename and expand Mackerel configuration example; add License section +67/-11

---

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

PR Reviewer Guide 🔍

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

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.