Skip to content

Commit a4a5c28

Browse files
committed
readme updates
1 parent f24dc43 commit a4a5c28

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# neardeps
2-
_an iOS shortcut for displaying nearest public transport departures_
2+
_an iOS shortcut for displaying nearest public transport stop's departures_
33

44
## General
55
This repository contains source code and auxiliary files for deploying Docker container - **back-end** and download link for iCloud shortcut - **front-end**.
@@ -24,7 +24,7 @@ This repository contains source code and auxiliary files for deploying Docker co
2424

2525
## API endpoint
2626
### Arguments
27-
At this stage of the project, API endpoint `/departures` implemented in [app.py](./app.py) can be queried with following arguments:
27+
At this stage of the project, API endpoint `[GET] /departures` implemented in [app.py](./app.py) can be queried with following arguments:
2828
| Argument | Type | Mandatory? | Description
2929
| --- | --- | --- | --- |
3030
| `city` | str | yes | City whose GTFS data shall be examined. So far, just `brno` is implemented |
@@ -76,12 +76,18 @@ returns JSON with following structure and values:
7676
"trip_id": 56563
7777
},
7878
// ...
79-
}
8079
],
8180
"nearest_stop": "Makovského náměstí"
8281
}
8382
```
8483

85-
## Motivation
84+
## Future updates
85+
- Other Czech cities
86+
- Back-end implementation is ready for additional cities, problem relies in obtaining [GTFS data](https://developers.google.com/transit/gtfs). In Czechia, only City of Brno provides pure GTFS data to public. Other cities' GTFS data are a bit harder to obtain, as CHAPS insists on using obsolete technology (see [this thread](https://www.infoprovsechny.cz/request/pristup_ke_skutecne_strojove_zpr)).
87+
- Solution however might be to indeed use `ftp://ftp.cisjr.cz` and convert JDF data to GTFS using [jdf2gtfs](https://www.infoprovsechny.cz/request/pristup_ke_skutecne_strojove_zpr) script by [@masopust](https://github.com/masopust)
88+
- Android shortcut?
89+
- As author does not posses any Android device, he will not be developing any Android front-end client soon. However, it should be very simple (as iOS shortcut is). If any Android user implements this in shareable form, please let the author know via GitHub issues.
90+
- Other features
91+
- If you have any suggestion, please add a feature request via GitHub issues.
8692

8793

0 commit comments

Comments
 (0)