Merge pull request #20 from YangVincent/vincent

incorporated google directions, license, and refactor usage

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010-2016 Google, Inc. http://angularjs.org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,6 +1,11 @@
 # Yelp and Chill
 [![Build Status](https://travis-ci.org/YangVincent/yelp-and-chill.svg?branch=vincent)](https://travis-ci.org/YangVincent/yelp-and-chill)
-![Heroku](https://heroku-badge.herokuapp.com/?app=yelp-and-chill)
+![Heroku](https://heroku-badge.herokuapp.com/?app=yelp-and-chill&style=flat)
+
+[![forthebadge](http://forthebadge.com/images/badges/powered-by-electricity.svg)](http://forthebadge.com)
+
+[<img src="yelp.png" alt="Powered by Yelp" width="144">](https://www.yelp.com/)
+[<img src="google.png" alt="Powered by Google" width="144">](https://www.google.com)
 
 ####Overview
 Today, 32% of people still don't have smart phones. As such, it is extremely difficult for them to find out about exciting new locations when traveling, or away from the
@@ -9,19 +14,21 @@ computer. This allows users to access Yelp through text.
 Additionally, many people have trouble deciding where to go. This helps users randomly decide a user-specified number
 of options to choose from, to help eliminate decision fatigue.
 
-As such, there are three main features to this program:
+As such, there are four main features to this program:
 
 1. Allow non-smartphones to still search for Yelp results, whereas they wouldn't normally be able to
 2. Randomly choose an option to combat group indecision when choosing a place to go
 3. Find details about results (phone number, address, ratings) 
+4. Give directions to an address through different modes of transportation
 
 ####Usage Instructions
-Currently, verified numbers can message `+16503977854` via. SMS. If the message is from a registered number, the response will greet by name. 
+Currently, verified numbers can message `+16503977854` via. SMS. 
 Text `usage` to `+16503977854` to see how to use the application. 
 
 1. Unfortunately, the Twilio account used is on the free version, but you can sign into [TextFree](textfree.us) to use the registered number `+15302978104`. 
 2. The username and password are both `yelpandchill`. To input newlines as specified in the example from desktop, press `shift+enter`.
 For the time being until I can find an application that can receive long messages from Twilio, there are certain constraints. 
+3. If you would like to register your number to be verified, feel free to email me. 
 
 `usage` typically texts back
 
@@ -90,9 +97,9 @@ San Diego Zoo
 Kensington Club
 ```
 
-Finally, the user can ask for details: for the example 
+The user can also ask for details: for the example 
 ```
-Detail
+detail
 San Diego
 Balboa Park
 ```
@@ -109,6 +116,35 @@ San Diego, CA 92101
 5.0/5 over 1443 reviews
 ```
 
+Finally, the user can get directions. For example if I am leaving from 
+*Sunnyvale Public Library, 665 West Olive Avenue, Sunnyvale, CA 94086*
+
+to 
+
+*Serra park, Tennis Courts, 730 The Dalles Avenue, Sunnyvale, CA 94085* and I want to drive,
+I can send:
+
+```
+direction
+Sunnyvale Public Library, Sunnyvale, CA
+Serra Park, Sunnyvale, CA
+driving
+```
+
+and the response will be
+```
+Start from: Sunnyvale, CA, USA
+End at: Serra park, Tennis Courts, 730 The Dalles Ave, Sunnyvale, CA 94085, USA
+Duration: 10 mins
+Distance: 3.1 mi
+Head east on El Camino Real
+Turn right onto E Remington Dr
+Turn left onto Hollenbeck Ave
+Turn right at Grand Coulee Ave; Destination will be on the right
+```
+
+Alternate modes of transportation are ```walking```, ```bicycling```, and ```transit```. Driving is the default mode of transportation.
+
 ####Developer Notes
 * [Requests](http://docs.python-requests.org/en/master/)
 * [Python Yelp](https://github.com/Yelp/yelp-python)
@@ -119,6 +155,8 @@ San Diego, CA 92101
 * [Deploying Travis then Heroku](http://phansch.net/2014/02/17/travis-heroku-rails/ )
 * [Travis encrypted environment variables](https://docs.travis-ci.com/user/encrypting-files/)
 * [Specific Unit Testing 2](https://www.twilio.com/blog/2014/03/unit-testing-your-twilio-app-using-pythons-flask-and-nose.html)
+* [Google Directions API](https://developers.google.com/maps/documentation/directions/)
+* [Google Directions Python API](https://github.com/googlemaps/google-maps-services-python)
 
 ####Branches
 * `master` - fully functional features

requirements.txt

@@ -6,3 +6,4 @@ Flask==0.11.1
 twilio==5.4.0
 yelp==1.0.2
 nose==1.3.7
+googlemaps==2.4.4