Published Easy Yelp v1.0.0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Hossein Rafiei
+
+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

@@ -0,0 +1,102 @@
+# Easy Yelp API Integration 
+
+**Easy Yelp** is a single file PHP client for [Yelp API](https://www.yelp.com/developers/documentation/v3/get_started).
+
+### Installation
+You can simply download the file and include it in your project.
+
+### Usage
+Include it in your project and create an instance.
+
+```php
+require 'yelp.php';
+```
+
+If you're using composer or autoloader then you don't need to include it manually. You just need to configure your autoloader tool.
+
+```php
+$yelp = new Yelp('YOUR_TOKEN');
+$businesses = $yelp->businessSearch([
+    'location' => 'Los Angeles, CA',
+    'price' => '1,2,3',
+    'sort_by' => 'distance',
+    'limit' => '30',
+])->getArray();
+```
+
+### Methods
+#### [Business Search](https://www.yelp.com/developers/documentation/v3/business_search)
+```php
+$request = [];
+$yelp->businessSearch($request)->getArray();
+```
+#### [Phone Search](https://www.yelp.com/developers/documentation/v3/business_search_phone)
+```php
+$request = [];
+$yelp->businessPhoneSearch($request)->getArray();
+```
+#### [Transaction Search](https://www.yelp.com/developers/documentation/v3/transaction_search)
+```php
+$request = [];
+$yelp->transactionSearch('delivery', $request)->getArray();
+```
+#### [Business Details](https://www.yelp.com/developers/documentation/v3/business)
+```php
+$businessId = 'blahblah'; 
+$request = [];
+$yelp->businessDetails($businessId, $request)->getArray();
+```
+#### [Business Match](https://www.yelp.com/developers/documentation/v3/business_match)
+```php 
+$request = [];
+$yelp->businessMatch($request)->getArray();
+```
+#### [Business Reviews](https://www.yelp.com/developers/documentation/v3/business_reviews)
+```php 
+$businessId = 'blahblah';
+$request = [];
+$yelp->businessReviews($businessId, $request)->getArray();
+```
+#### [Autocomplete](https://www.yelp.com/developers/documentation/v3/autocomplete)
+```php 
+$request = [];
+$yelp->autocomplete($request)->getArray();
+```
+#### [Event Lookup](https://www.yelp.com/developers/documentation/v3/event)
+```php 
+$eventId = 'blahblah';
+$request = [];
+$yelp->eventDetails($eventId, $request)->getArray();
+```
+#### [Event Search](https://www.yelp.com/developers/documentation/v3/event_search)
+```php 
+$request = [];
+$yelp->events($request)->getArray();
+```
+#### [Featured Event](https://www.yelp.com/developers/documentation/v3/featured_event)
+```php 
+$request = [];
+$yelp->featuredEvent($request)->getArray();
+```
+#### [All Categories](https://www.yelp.com/developers/documentation/v3/all_categories)
+```php 
+$request = [];
+$yelp->categories($request)->getArray();
+```
+#### [Category Details](https://www.yelp.com/developers/documentation/v3/category)
+```php
+$alias = 'blahblah'; 
+$request = [];
+$yelp->categoryDetails($alias, $request)->getArray();
+```
+### Errors
+To check if you received an error from Yelp API or not you can use following functions.
+```php
+$businesses = $yelp->businessSearch($request)->getArray();
+if($yelp->hasError()) // We have an error
+{
+    echo $yelp->getError(); // Print the error message
+}
+```
+### License
+This software released under **MIT License**.