Skip to content

Simplify the README for first-time setup - #11

Merged
aniceberg merged 1 commit into
mainfrom
claude/simplify-readme
Nov 5, 2026
Merged

aniceberg merged 1 commit into
mainfrom
claude/simplify-readme

Conversation

@aniceberg

Copy link
Copy Markdown
Owner

Makes the README a short guide for someone setting up Bus Monitor for the first time.

  • Order: what it does, what you need, five setup steps, everyday use, then help.
  • Sources: a table helps people choose between Traccar, Bouncie and a tracker already in Home Assistant.
  • Several sources: corrects the wording to say Bus Monitor is installed once and connects to several sources. docs/bouncie.md now matches.
  • Security: the note described one particular server as if it applied to everyone, and now covers any Traccar server. It also explains how an address with no http:// or https:// is handled.
  • Moved, not dropped: alert rules, event data, entities and services are now in docs/reference.md. Development, brand images and the roadmap are in CONTRIBUTING.md.

Docs only, so no release is needed. The existing tests still pass, and relative links were checked. The my.home-assistant.io integration-page links are new and haven't been clicked.

🤖 Generated with Claude Code

Move alert rules, event data, entities and services to docs/reference.md, and development
notes to CONTRIBUTING.md. Correct the wording on using several sources, and make the
security note apply to any Traccar server.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-05T01:13:50.319183Z 4b31d13 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@aniceberg
aniceberg merged commit c98c2cb into main Nov 5, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant