Update README.md

README.md

@@ -1,9 +1,7 @@
-# xkcd-map-reactions
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
-Just a small fun tool that maps sentences to routes, that can be displayed on maps. It is based on https://xkcd.com/2260/. 
+# XKCD Map Reactions
+Just a small fun tool that maps sentences to routes, that can be displayed on maps. It is based on https://xkcd.com/2260/. Some further information about how this was implemented can be found in [this blog post](https://ksick.dev/implementing-xkcds-map-reactions).
 
+# Project Structure
 Each folder in this repository contains a part of the implementation which is described below. 
 
 ## backend
@@ -19,18 +17,15 @@ To run the function locally [AWS SAM](https://docs.aws.amazon.com/serverless-app
 ## dbMigration
 This part of the project can be used to set up the database. It is a Java project that is using the [Flyway Maven Plugin](https://flywaydb.org/getstarted/firststeps/maven) to create database migrations. There are several steps you need to complete, to get it running:
 
-1. In the pom.xml file, you need to enter your database url, user and password in the configuration section of the flyway-maven-plugin. The url should look like this: jdbc:postgresql://\<host\>:\<port\>/\<database\>
+1. In the pom.xml file, you need to enter your database url, user and password in the configuration section of the flyway-maven-plugin. The url should look like this: `jdbc:postgresql://\<host\>:\<port\>/\<database\>`
 2. You need to download the US.zip file from http://download.geonames.org/export/dump/, extract it, and place the US.txt file in the resources folder (src/main/resources/). Unfortunately the file is too large to be pushed to git.
-3. Run mvn compile
-4. Check if everything is ok with mvn flyway:info and then migrate everything with mvn flyway:migrate. Depending on your machine and database this can take up to 10 hours, but if everything is local it should complete within 2 or 3 hours.
+3. Run `mvn compile`
+4. Check if everything is ok with `mvn flyway:info` and then migrate everything with `mvn flyway:migrate`. Depending on your machine and database this can take up to 10 hours, but if everything is local it should complete within 2 or 3 hours.
 
 ## frontend
 The frontend is not implemented yet, but will follow in the next weeks.
 
-## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
+# Contributors
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
@@ -44,5 +39,3 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-enable -->
 <!-- prettier-ignore-end -->
 <!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!