From d647cb535790d2260c014078e1dd8f0a892ac936 Mon Sep 17 00:00:00 2001 From: Keith Irwin Date: Mon, 7 Aug 2017 17:10:55 -0400 Subject: [PATCH] Added README information --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 29456aa..ddae564 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ -# streetme -Show a streetview image of your current location +# Streetme +###### by [Keith Irwin](https://keithirwin.us/) + +Streetme is a web app written in plain HTML/CSS/JS. It uses [geolocation](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation) and [google street view](https://developers.google.com/maps/documentation/javascript/streetview) to show a panoramic image of your current location. + +## Instructions + +Open [streetmap.me](https://streetmap.me/). Grant location permission to the website. After a few moments, you should see an image of your location. + +### Moving or not + +If you're stationary, the image will be of the street nearest to your location, and the orientation will be pointed in your direction. If you're in a building, the image should show the building from the street. You can pan around, but the image will snap back to the building when the location updates. + +If you're moving, the image will show the closest street and will be oriented in the direction of travel. When driving down the road, this produces an effect like a low framerate dashcam.