Update README
lukasdenk opened this issue · 3 comments
The README contains some old parts. E.g., it announces a change which will happen in 2020.
If you recognize other parts to update, please leave a comment.
The output of the help command in the README.md is not the same as the one you get by entering the command.
While the one in the README.md includes all parameters, in the terminal I'm missing a few ones:
eat-api % python src/main.py -h
usage: main.py [-h] [-p LOCATION] [-d DATE] [-j PATH] [-c] [--openmensa PATH] [-l]
optional arguments:
-h, --help show this help message and exit
-p LOCATION, --parse LOCATION
the location you want to eat at
-l, --locations prints all available locations formated as JSON
I think the output in the README is better, but it can be confusing, that they are different.
I haven't figured how to fix the output, but I'm quite sure, that the issue is regarding to the mutually exclusive parse groups:
Line 23 in 69e04ad
Yes, I agree. The README.m could be updated a bit like removing the "will happen in 2020" and fixing the example.