Repository navigation
Update README and website documentation for new API - #19
Merged
chtitux merged 1 commit intoNov 7, 2025
Merged
Conversation
This commit updates all documentation to reflect the new unified filter-based API: 1. **README.md Updates:** - Added comprehensive Migration Guide section explaining the API changes - Updated all code examples to use new filter-based API - Fixed Complete Example section to use new methods - Cleaned up API Reference section to show current methods only - Added array filtering examples - Added documentation for new GTFS-RT time/delay fields - Removed references to deprecated getXXXByYYYY methods 2. **Website Demo Updates:** - Updated demo.ts to use new filter-based API - Fixed getStopById and getRouteById calls Key improvements in documentation: - Clear migration guide for users upgrading from older versions - Examples showing both single value and array filtering - Documentation of new GTFS-RT features (time and delay fields) - Consistent examples throughout the README All tests passing ✅
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.
This commit updates all documentation to reflect the new unified filter-based API:
README.md Updates:
Website Demo Updates:
Key improvements in documentation:
All tests passing ✅