diff --git a/README.md b/README.md index eed6274b18..1d63e72881 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,21 @@ https://srehwald.github.io/eat-api/mensa-garching/2017/09.json ### CLI The JSON files are produced by the tool shown in this repository. Hence, it is either possible to access the API or use the tool itself to obtain the desired menu data. The CLI needs to be used as follows: + ``` $ python src/main.py -h usage: main.py [-h] [-d DATE] [-j PATH] - {mensa-garching,mensa-arcisstrasse,stubistro-grosshadern,fmi-bistro,ipp-bistro} + {fmi-bistro,ipp-bistro,mensa-arcisstr,mensa-arcisstrasse,mensa-garching,mensa-leopoldstr,mensa-lothstr, + mensa-martinsried,mensa-pasing,mensa-weihenstephan,stubistro-arcisstr,stubistro-goethestr, + stubistro-großhadern,stubistro-grosshadern,stubistro-rosenheim,stubistro-schellingstr, + stucafe-adalbertstr,stucafe-akademie-weihenstephan,stucafe-boltzmannstr,stucafe-garching,stucafe-karlstr, + stucafe-pasing} positional arguments: - {mensa-garching,mensa-arcisstrasse,stubistro-grosshadern,fmi-bistro,ipp-bistro} + {fmi-bistro,ipp-bistro,mensa-arcisstr,mensa-arcisstrasse,mensa-garching,mensa-leopoldstr,mensa-lothstr, + mensa-martinsried,mensa-pasing,mensa-weihenstephan,stubistro-arcisstr,stubistro-goethestr,stubistro-großhadern, + stubistro-grosshadern,stubistro-rosenheim,stubistro-schellingstr,stucafe-adalbertstr,stucafe-akademie-weihenstephan, + stucafe-boltzmannstr,stucafe-garching,stucafe-karlstr,stucafe-pasing} the location you want to eat at optional arguments: @@ -58,14 +66,16 @@ optional arguments: directory for JSON output (date parameter will be ignored if this argument is used) ``` + It is mandatory to specify the canteen (e.g. mensa-garching). Furthermore, you can specify a date, for which you would like to get the menu. If no date is provided, all the dishes for the current week will be printed to the command line. the `--jsonify` option is used for the API and produces some JSON files containing the menu data. #### Example Here are some sample calls: + ``` # Get the menus for the whole current week at mensa-garching $ python src/main.py mensa-garching # Get the menu for April 2 at mensa-arcisstrasse $ python src/main.py mensa-arcisstrasse -d 02.04.2017 -``` \ No newline at end of file +```