diff --git a/README.md b/README.md index cbc39c7..99450a0 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Allgemeines **Was müssen ich beachten?** * Der Code bzw. die API ist nicht von einem Profi, sondern von einem Lehrling im ersten Lehrjahr programmiert worden. Deswegen bitte ich um ausschließlich konstruktive Kritik. +* Zu jeder Funktion gibt es auch ein Beispiel. Siehe PDF. * Es gelten die Allgemeinen Geschäftsbedingungen und die Nutzungsbedingungen von [oebb.at](http://oebb.at). [http://www.oebb.at/de/Nutzungsbedingungen/index.jsp](http://www.oebb.at/de/Nutzungsbedingungen/index.jsp) * Es wird keine Haftung übernommen! Sie sind für ihr Handeln selbst verantwortlich. Der Rechtsweg ist ausgeschlossen! @@ -34,12 +35,17 @@ Station validieren - validate 1. Es ist zu beachten, dass bei einem Aufruf mehrere Stationen zurückkommen können. 2. Für den weiteren Vorgang wird ausschließlich der name („value“) benötigt. -**Syntax** -`Input:` -`name (string) Name der Station` +**Useage** +| Name | Typ | Beschreibung | Zwingend benötigt | +|------|--------|------------------| ----------------- | +| name | string | Name der Station | X | + +**Rückgabewerte** +| Name | Typ | Beschreibung | Wird benötigt | +|------|-----|--------------| ----------------- | +| value | string | Gültiger Name der Station | X | +| id | int | Irgend eine ÖBB Stations ID | | + -`Output:` -`value (string) * Gültiger Name der Station` -`id (int) Irgend eine ÖBB Stations ID`