From 6ee3b05f15369a1be89eadfb54d1150ff8f76aea Mon Sep 17 00:00:00 2001 From: Josh Sherman Date: Thu, 13 Dec 2012 22:55:33 -0500 Subject: [PATCH] Editing README I just prefer the github editor for markdown editing. --- README.md | 28 +++++++++------------------- 1 file changed, 9 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 378ff65..b66c846 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ PHP Wrapper for the Google Places API. Origins ------- -Simply put, when I Googled "php google places" I was presented with [https://github.com/anthony-mills/Google-Places---PHP-]. I attempted to use it, and it was fine as I was able to make it work, but there seemed to be a huge assumption that you already know the Google Places API. +Simply put, when I Googled "php google places" I was presented with [Google-Places---PHP-](https://github.com/anthony-mills/Google-Places---PHP-). I attempted to use it, and it was fine as I was able to make it work, but there seemed to be a huge assumption that you already knew a lot of the quirks of the Google Places API. -I did not fit into this assumption and set out to built my own wrapper with a heavy focus on sanity checking inputs, utilizing the magical parts of PHP (reads you interact directly with the objecta as you would the API) and avoiding setter methods as they were put here by the devil. +I did not fit into this assumption and set out to built my own wrapper with a heavy focus on sanity checking inputs, utilizing the magical parts of PHP (reads: you interact directly with the object as you would the API) and avoiding setter methods as they were put here by the devil. I didn't fork because I was going to change too much and I highly doubt my pull requests would have been accepted. @@ -18,38 +18,28 @@ Usage Examples ### Getting started ```php - ``` ### Search nearby, ranked by prominence ```php -location = array(-33.86820, 151.1945860); $google_places->radius = 800; - -$places = $google_places->searchNearby(); - -?> +$results = $google_places->searchNearby(); ``` ### Search nearby, ranked by distance ```php -location = array(-33.86820, 151.1945860); $google_places->rankby = 'distance'; $google_places->types = 'restaurant'; // Requires keyword, name or types - -$places = $google_places->searchNearby(); - -?> +$results = $google_places->searchNearby(); ``` + +The Fututre +----------- + +Assuming December 21st, 2012 doesn't lead to humanity's demise, the plan is to continue implementing the entire Google Places API into this class and eventually migrating it into my PHP Framework [PICKLES](https://github.com/joshtronic/pickles).