From 6571c025f32a0bf75e68deed83ab344b639fe8e6 Mon Sep 17 00:00:00 2001 From: Josh Sherman Date: Sat, 13 Sep 2014 07:59:03 -0400 Subject: [PATCH] Updated README Added installation instructions and included the namespace in the references. Also reformatted the file to wrap at 80 columns. Closes #11 --- README.md | 38 +++++++++++++++++++++++++++++++------- 1 file changed, 31 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a8a8d34..85c38a5 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,40 @@ PHP Wrapper for the Google Places API. ## Origins -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. +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 object 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 opted not to fork because I was going to change too much and I highly doubt my pull requests would have even been accepted. +I opted not to fork because I was going to change too much and I highly doubt +my pull requests would have even been accepted. -## Usage Examples +## Installation + +The preferred installation is via `composer`. First add the following to your +`composer.json` + +```json +"require": { + "joshtronic/php-googleplaces": "dev-master" +} +``` + +Then run `composer update` + +## Usage ### Getting started ```php -require_once 'GooglePlaces.php'; -$google_places = new GooglePlaces('_YOUR_API_KEY_'); +require_once 'joshtronic/GooglePlaces.php'; +$google_places = new joshtronic\GooglePlaces('_YOUR_API_KEY_'); ``` ### Search nearby, ranked by prominence @@ -71,4 +92,7 @@ $details = $google_places->details(); ## The Future -The project that I created this library for is now defunct so I’m not actively using it or hacking on it. That being said, if there’s something you want to see included or you find a bug, just open an issue or grow a pair and fork, hack and send a pull request ;) +The project that I created this library for is now defunct so I’m not actively +using it or hacking on it. That being said, if there’s something you want to +see included or you find a bug, just open an issue or grow a pair and fork, +hack and send a pull request ;)