doc: add README

iam4x · Jul 15, 2016 · 8173944 · 8173944
1 parent 5b229fe
commit 8173944
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# ![pikachu](./pikachu.gif) Pokémon GO - WebSpoof
+> Spoof your iOS device GPS location for Pokémon Go
+
+![Example](./example.gif)
+
+## Features
+
+* Jump to places with AlgoliaPlaces search :rocket:
+* Switch between different speed presets
+* Total distance counter (it differs from Pokémon Go incubator counter?)
+* Current speed counter
+* Include Pokémon spots from a [collaborative map](https://www.google.com/maps/d/u/0/viewer?mid=1vsj869Axn9JdWairc4xU6E_0DhE&hl=en_US) (might not be accurate, will update)
+
+## Requirements
+
+* Xcode installed
+* An iOS device with Pokémon Go connected to your Mac
+
+## How-to
+
+1. Start Pokémon Go on your iOS device & connect to your Mac
+2. Start the `pokemongo-webspoof` app, it will start also Xcode
+3. Build & run Xcode project on your connected iPhone
+4. Check the `Auto update Xcode location` in the app when everything is running
+5. Go back to Xcode, click into menu Debug -> Simulate Location -> pokemonLocation
+6. And voilà, you can move with the arrows key and see your character move
diff --git a/example.gif b/example.gif
diff --git a/pikachu.gif b/pikachu.gif