Skip to content

Update README and website documentation for new API - #19

Merged
chtitux merged 1 commit into
mainfrom
claude/update-api-documentation-011CUtRt1d4j49UTEg86gufv
Nov 7, 2025
Merged

chtitux merged 1 commit into
mainfrom
claude/update-api-documentation-011CUtRt1d4j49UTEg86gufv

Conversation

@chtitux

@chtitux chtitux commented Nov 7, 2025

Copy link
Copy Markdown
Contributor

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 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 ✅
@chtitux
chtitux merged commit b17bad3 into main Nov 7, 2025
3 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.

2 participants