From d87f9977ef369693f83647f04ceef41310f240c6 Mon Sep 17 00:00:00 2001 From: Josh Creek Date: Sun, 23 May 2021 21:45:29 +0100 Subject: [PATCH] feat(*): Update readme to include description of the project and running instructions --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 015a681..297410a 100644 --- a/README.md +++ b/README.md @@ -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.