From 52c112583853e3a9282837c9cc54d6eedee77479 Mon Sep 17 00:00:00 2001 From: Fred Boniface Date: Sat, 2 Nov 2024 21:23:36 +0000 Subject: [PATCH] Update readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 108fb08..48a8794 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,18 @@ This client was written as part of 'dgp2'. As it stands, only the features required for dgp2 and few others are implemented. -# PyPI +# Endpoints + +The following API features are available: + - get_stops_by_pis + - get_pis_by_start_end_crs + - get_trains_by_headcode + - get_trains_by_trainUid + - get_loc_ref_codes_by_tiploc + +No other features are currently exposed. In the meantime, consider OwlBoardTS which is a fully featured API Client for use with TypeScript. + +# Installing The package can be installed with `pip`: