diff --git a/README.md b/README.md index 1392baa3066f83db90265c11dfafcbf442d2cf41..1dc669e14209512ad69b83135f8a7456ac926775 100644 --- a/README.md +++ b/README.md @@ -46,10 +46,35 @@ pip install -r requirements.txt ## Usage -### Set settings.py - -Set base url to the running API (local ex.: localhost:PORT): +### Configuring settings.py +Set base url to the running API. +Default route of LDE: ``` BASE_URL="https://simcaq.c3sl.ufpr.br/api/v1/" -``` \ No newline at end of file +``` +Local environment route: +``` +BASE_URL="localhost:PORT" +``` +### Command Instructions + +``` +usage: manage.py <command> [<args>] + +positional arguments: + command the command to run + +optional arguments: + -h, --help show this help message and exit + +available commands: + compare Compare multiple or one CSV route + save Save multiple or one CSV route + -h, --help show this help message and exit + --route ROUTE no description +``` + +### Saving route + +### Compare routes \ No newline at end of file