Updated readme to 0.3.0

This commit is contained in:
2022-10-07 13:47:25 +02:00
parent ed44947277
commit 551babedb7
3 changed files with 7 additions and 15 deletions

View File

@@ -40,7 +40,6 @@ trip = client.trip_find(origin_id=origin.id, dest_id=destination.id)
- [Why are there raw versions and formatted ones?](#why-are-there-raw-versions-and-formatted-ones)
- [Some methods work slightly different](#some-methods-work-slightly-different)
- [Documentation is not perfectly clear](#documentation-is-not-perfectly-clear)
## Why are there raw versions and formatted ones?
@@ -55,13 +54,6 @@ Can be. Not all function arguments written may work perfectly because I simply d
every request. Some of arguments may be irrelevant in my use-case and the others are used quite rare at all.
Just [make an issue](https://git.end-play.xyz/profitroll/PythonRMV/issues/new) and I'll implement it correct when I'll have some free time.
## Documentation is not perfectly clear
Of course docs cannot be perfect as a python docstring, especially if sometimes I don't
know how things should correctly work. That's why you get HAFAS API docs in addition to your
RMV API key. Just use my functions together with those docs, if you want to build something
really sophisticated. However I'm not sure whether RMV supports that many HAFAS features publicly.
# To-Do
## General
- [ ] Docs in Wiki
@@ -79,7 +71,7 @@ really sophisticated. However I'm not sure whether RMV supports that many HAFAS
## Normal methods
- [x] arrivalBoard (board_arrival)
- [x] departureBoard (board_departure)
- [ ] himsearch (him_search)
- [x] himsearch (him_search)
- [x] journeyDetail (journey_detail)
- [x] location.nearbystops (stop_by_coords)
- [x] location.name (stop_by_name)