jcreek/CityFinder
1
0
Fork 0
mirror of https://github.com/jcreek/CityFinder.git synced 2026-07-12 18:33:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(*): Update readme to include description of the project and running instructions

Browse Source
This commit is contained in:
Josh Creek
2021-05-23 21:45:29 +01:00
parent a816ca4cac
commit d87f9977ef
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -1
View File
@@ -1,2 +1,13 @@
# CityFinder
A small console application to find a city from a country code and zip/postal code.
A small console application to find a city from a country code and zip/postal code. This was completed for the Code2Gether community June Challenge in 2021.
## Required configuration
To get this running, specify your own Google API key in the `GoogleMapsGeocodeApiKey` property in `appsettings.json`. You can get this by visiting [the Google APIs website](https://console.cloud.google.com/apis/library/geocoding-backend.googleapis.com).
Otherwise, it's just a standard console application.
## Instructions for use
Enter a valid country code and a zip/postal code and it should tell you which city/town/village that zip/postal code is in.