Repository navigation
README hero: CLI GIF, Board screenshot, and a client comparison - #7
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README now opens with a short recording of the
tflCLI, a screenshot of the Board, and a comparison against the other public TfL clients.package.jsonhomepageis 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.comURLs onmain, so they render on npm after merge. The comparison was checked against each repo's source and thepackage.jsonon 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.
Offline station-hub example. Add
examples/station-hub.tsthat loadsSTATION_HUBSandresolveArrivalsStopIdfor Liverpool Street (940GZZLULVTresolves Elizabeth line arrivals to910GLIVST). No API key.examples/currently covers the tube/bus mapping and a live arrivals CLI.River-bus pier example. Add a short example that polls the pier (
NaptanFerryPort, ids starting930G) and explains why a berth id (9300…) comes back empty. The README already states this. There is no file to copy.Stop compass example. Add
examples/stop-compass.tsforstopPoint.getliftingtowards,compassPoint, andcompassBearingDegrees(the490013766Estop in the README). Predictionbearingis the vehicle heading. A painted stop letterWis Stop W.Quieter
tfl checkfailure. Insrc/bin/tfl.ts,runCheckprints the report and then throwsCliErrorwith the same fix sentence, so a bad slug such asCentralprints the hint twice. Print the report once.Offline station-order script. Add
examples/station-order.tsthat prints Bakerloo outbound Regular station ids fromLINE_STATION_SEQUENCES, so someone can run the package before they have a TfL key. The snippet lives in the README only.