Skip to content

docs: rewrite the README for a public audience - #10

Merged
xAlcahest merged 1 commit into
mainfrom
docs/readme
Aug 25, 2026
Merged

docs: rewrite the README for a public audience#10
xAlcahest merged 1 commit into
mainfrom
docs/readme

Conversation

@xAlcahest

Copy link
Copy Markdown
Owner

Summary

The README opened with history and a feature list; it now opens with what the app does for a rider and why the implementation is worth reading. The technical sections (Docker, refresh, sync, smoke test, architecture) are unchanged apart from a new Languages section and a paragraph on vehicle motion between polls.

Changes

  • README.md: new opening and "What it does" section, Deploying summary, Languages section, motion paragraph in the stop map section.

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@xAlcahest
xAlcahest merged commit bd32fa5 into main Aug 25, 2026
4 checks passed
@xAlcahest
xAlcahest deleted the docs/readme branch August 25, 2026 15:03
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.

2 participants