From 758e6781b94aa6849cf94eba1287708e973b1e6b Mon Sep 17 00:00:00 2001
From: edwilding <31126314+edwilding@users.noreply.github.com>
Date: Fri, 23 Aug 2019 09:22:56 +0100
Subject: [PATCH] Create README.md

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0241f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# geogame
+A geoguessr inspired game, using individual's api keys.
+
+**What is this?**
+
+This is a game that uses Geoguessr as inspiration.
+
+**Why does this exist?**
+
+Sadly, because of Google's predatory pricing strategy for their Maps api, geoguessr have had to modify their game in a detrimental way to cut costs.
+
+I created this project to allow people to play the game how it used to be (or as close to it).
+
+**What does the "Broken Streetview" button do?**
+
+Sometimes a coordinate with no valid streetview is selected for you, you will just get a black screen.
+
+If this occurs please click the "Broken Streetview" button and you will be provided with a new scene and the faulty coordinate will be removed from the database.