Skip to content

README hero: CLI GIF, Board screenshot, and a client comparison - #7

Merged
ghcpuman902 merged 2 commits into
mainfrom
cursor/readme-hero-comparison-1c7c
Oct 16, 2026
Merged

ghcpuman902 merged 2 commits into
mainfrom
cursor/readme-hero-comparison-1c7c

Conversation

@ghcpuman902

@ghcpuman902 ghcpuman902 commented Oct 16, 2026 •

Copy link
Copy Markdown
Owner

The README now opens with a short recording of the tfl CLI, a screenshot of the Board, and a comparison against the other public TfL clients. package.json homepage is https://tfl.manglekuo.com. Version is 2.15.1. Nothing is published to npm, and this pull request is not merged.

README images use absolute raw.githubusercontent.com URLs on main, so they render on npm after merge. The comparison was checked against each repo's source and the package.json on npm (16 October 2026). Coverage is the 84 operations in the committed OpenAPI snapshot (ENDPOINT_COUNT, pathCount). No cell is marked ?.

Good first issues

Ideas only. This pull request does not open them.

  1. Offline station-hub example. Add examples/station-hub.ts that loads STATION_HUBS and resolveArrivalsStopId for Liverpool Street (940GZZLULVT resolves Elizabeth line arrivals to 910GLIVST). No API key. examples/ currently covers the tube/bus mapping and a live arrivals CLI.

  2. River-bus pier example. Add a short example that polls the pier (NaptanFerryPort, ids starting 930G) and explains why a berth id (9300…) comes back empty. The README already states this. There is no file to copy.

  3. Stop compass example. Add examples/stop-compass.ts for stopPoint.get lifting towards, compassPoint, and compassBearingDegrees (the 490013766E stop in the README). Prediction bearing is the vehicle heading. A painted stop letter W is Stop W.

  4. Quieter tfl check failure. In src/bin/tfl.ts, runCheck prints the report and then throws CliError with the same fix sentence, so a bad slug such as Central prints the hint twice. Print the report once.

  5. Offline station-order script. Add examples/station-order.ts that prints Bakerloo outbound Regular station ids from LINE_STATION_SEQUENCES, so someone can run the package before they have a TfL key. The snippet lives in the README only.

Open in Web Open in Cursor 

cursoragent and others added 2 commits October 16, 2026 07:51
Add a short tfl CLI recording, a screenshot of tfl.manglekuo.com, and a comparison with the other TfL clients. Point the npm homepage at the Board.

Co-authored-by: Mangle Kuo <ghcpuman902@users.noreply.github.com>
Point the README images at raw GitHub URLs so they render on npm, and record the docs release in the changelog.

Co-authored-by: Mangle Kuo <ghcpuman902@users.noreply.github.com>
@ghcpuman902
ghcpuman902 merged commit f206b5d into main Oct 16, 2026
1 check 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.

2 participants