Update instructions in README

[jlumpe]

Tried to write out a more complete set of instructions in the README. A lot is just the comments previously in the code example, moved to their own section and with Markdown formatting applied.

Summary by CodeRabbit

• Documentation
  • Added step-by-step guide to implement and register a logger plugin.
  • Introduced a migration guide from legacy log-handler scripts, with examples.
  • Documented available log events and typical fields, including usage examples.
  • Simplified examples and normalized terminology for better readability.
  • Streamlined references to configuration options to reduce ambiguity.
  • Reorganized README with a dedicated Instructions section for quicker onboarding.

[coderabbitai]

📝 Walkthrough

Walkthrough

README.md was updated to reorganize and expand logger plugin documentation, including simplified settings examples, streamlined handler docs, added implementation/registration instructions, a migration guide from log-handler scripts, and a new section detailing available log events and typical fields.

Changes

Cohort / File(s)	Summary of changes
Docs: Logger plugin guide README.md	Removed advanced LogHandlerSettings metadata keys from examples; simplified LogHandler-related comments; normalized property/method docstrings; added instructions for plugin registration and implementation; added migration guide from log-handler scripts with examples; added “Available Log Events” section with event-field guidance and usage examples.

Sequence Diagram(s)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• docs: update readme #29 — Also reorganizes and expands logger plugin README, including migration guide and LogHandler/Settings details.
• feat!: API simplification #9 — Adjusts logger plugin surface, touching LogHandler/LogHandlerBase behavior and LogHandlerSettings structure.

Suggested reviewers

• cademirch

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly summarizes the primary change by noting that the README instructions have been updated, matching the PR’s focus on moving and expanding documentation in the README.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 62b5181 and 9398e9d.

📒 Files selected for processing (1)

• README.md (3 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}