Thomas Kandler 7 years ago
parent
commit
db0bc52020
1 changed files with 8 additions and 0 deletions
  1. 8
    0
      README.md

+ 8
- 0
README.md View File

@@ -18,6 +18,14 @@ Just run the script by providing a .txt file with each location to geocode on a
18 18
   
19 19
 The script will access `API.json` for API keys (if neccessary) and will output `cities.csv` as well as `outliers.txt`. Don't forget to update your `API.json` to get access to the MapQuest, HERE and OpenCage geocoding results. The `outliers.txt` is some kind of shoot from the hip for evaluating the quality of the data. Outliers will be summarized in the console and simply mean that the coordinates for a location are not within the standard deviation of all 5 providers. This is by no means a real measure for quality, just a hint or a reminder to implement some real quality measurement.
20 20
 
21
+### Files
22
+
23
+`API.json` - credentials for the geocoding APIs
24
+`cities.csv` - main output; CSV with header; example results included
25
+`cities.txt` - input file; each location on new line; examples included
26
+`console_output.txt` - example for console output
27
+`outliers.txt` - supposed outliers 
28
+
21 29
 ### Version
22 30
 
23 31
 * querying APIs works