Expanded examples, cleaned up and expanded for other developers to kickstart their projects

Formatting corrections

Author: gegere

.gitignore

@@ -7,9 +7,8 @@
 .Trashes
 ehthumbs.db
 Thumbs.db
-
+.env
 
 # Development
 ######################
-composer.lock
-vendor
+vendor

README.md

@@ -8,10 +8,9 @@ The [Checkfront Booking API](http://www.checkfront.com/developers/api/) allows y
 This repository contains the open source PHP SDK and various example scripts. Except as otherwise noted, the Checkfront PHP SDK is licensed under the Apache Licence, Version 2.0
 (http://www.apache.org/licenses/LICENSE-2.0.html)
 
-
+---
 
 ## Features
----
 
 The Checkfront API SDK provides the following functionality:
 
@@ -25,7 +24,6 @@ The Checkfront API SDK provides the following functionality:
 
 
 ## Installation & Usage
----
 
 This repo is setup to extend off of the library created by Checkfront. To update this library, a Composer.json file has been created. 
 
@@ -35,44 +33,47 @@ If you are not using [Composer](http://getcomposer.org), you should be. It's an
 
 Let's install Checkfront-PHP-DK via the following few commands:
 
->	Type `composer` for more options:
+>   Type `composer` for more options:
 
 ```
 $ composer init --require="checkfront/checkfront:3.0.*" -n 
 $ composer install
 ```
 
-
-Now the needed code should be available within your project. At the top of your PHP script require the autoloader, if you are using a MVC such as CodeIgnitor or Laravel review their autoload guides. Obtain API credintials [https://{your-company}.checkfront.com/manage/developer/](https://{your-company}.checkfront.com/manage/developer/)
-
 ```bash
 require 'vendor/autoload.php';
 ```
+Now the needed code should be available within your project. At the top of your PHP script require the autoloader, if you are using a MVC such as CodeIgnitor or Laravel review their autoload guides. 
+Obtain API credintials [https://{your-company}.checkfront.com/manage/developer/](https://{your-company}.checkfront.com/manage/developer/)
+
+
+
+---
 
 > The repo example files are a good place to start. 
 
 ```shell
 PHP-SDK                         # → Root of Service
-└── examples/                     		  
+└── examples/
    └── cart
-    	├── Cart.php 			# → Main wrapper class, ADD API KEY
-    	├── create.php   		# → Process $_POST request, add to cart session
-    	├── Form.php  			# → Various PHP functions
-    	├── index.php 			# → Default view, list avaiable inventory
-    	└── README.md 			# → File overview
+	   ├── Cart.php         # → Main wrapper class, ADD API KEY
+	   ├── create.php       # → Process $_POST request, add to cart session
+	   ├── Form.php         # → Various PHP functions
+	   ├── index.php        # → Default view, list available inventory
+	   └── README.md        # → File overview & tips
 ```
 
 #### OAuth2 Access
 
 ```php
 <?php
 $Checkfront = new Checkfront(
-    array(
-        'host' => 'your-company.checkfront.com',
-        'consumer_key' => '5010076404ec1809470508',
-        'consumer_secret' => 'ba0a5c0c509445024c374fcd264d41e816b02d4e',
-        'redirect_uri' => 'oob',
-    ));
+	array(
+		'host' => 'your-company.checkfront.com',
+		'consumer_key' => '5010076404ec1809470508',
+		'consumer_secret' => 'ba0a5c0c509445024c374fcd264d41e816b02d4e',
+		'redirect_uri' => 'oob',
+	));
 ?>
 ```
 
@@ -81,31 +82,31 @@ $Checkfront = new Checkfront(
 ```php
 <?php
 $Checkfront = new Checkfront(
-    array(
-        'host'=>'your-company.checkfront.com',
-	    'auth_type' => 'token',
-        'api_key'  => '5010076404ec1809470508',
-        'api_secret' => 'ba0a5c0c509445024c374fcd264d41e816b02d4e',
-    ));
+	array(
+		'host'=>'your-company.checkfront.com',
+		'auth_type' => 'token',
+		'api_key'  => '5010076404ec1809470508',
+		'api_secret' => 'ba0a5c0c509445024c374fcd264d41e816b02d4e',
+	));
 ?>
 ```
 
-### PHP Examples
+#### PHP Examples
 ```php
 <?php
 // Get items rates and availbility
 $items = $Checkfront->get('item',array(
-    'start_date'=>date('Y-m-d'),
-    'end_date'=>date('Y-m-d',strtotime('+3 days'))
-));
+			'start_date'=>date('Y-m-d'),
+			'end_date'=>date('Y-m-d',strtotime('+3 days'))
+		));
 
 print_r( $items );
 
 // fetch all bookings
 public function query_booking() 
 {
-    $response = $this->Checkfront->get('booking/index');
-    return $response;
+	$response = $this->Checkfront->get('booking/index');
+	return $response;
 }
 
 print_r(query_booking() );
@@ -134,12 +135,23 @@ Move the following example file `notifications-example.php` to a place of your c
 ### Notification Service Breakdown
 
 ```shell
-PHP-SDK                                  # → Root of Service
-└── scripts/                     		  
+PHP-SDK                                 # → Root of Service
+└── scripts/
    └── notifications
-    	├── includes
-    	│ 	├── db.class.php   		     # → DB Interface Class 
-    	│ 	└── notifications.class.php  # → Parse of incoming data
-    	├── notifications-example.php 	 # → Processing Example file
- 	  	└── notifications.sql   		 # → DB Example File
+	   ├── includes
+	   │   ├── db.class.php             # → DB Interface Class 
+	   │   └── notifications.class.php  # → Parse of incoming data
+	   ├── notifications-example.php    # → Processing Example file
+	   └── notifications.sql            # → DB Example File
 ```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes
+4. Run the tests, adding new ones for your own code if necessary (`phpunit`)
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

examples/cart/README.md

@@ -1,48 +1,39 @@
-Sample Reservation System
-==========================
+## Reservations Booking Demo
 
-The Booking Cart demo is a bare bones shopping card style booking page.  It is not intended 
-for production use, and should act an example only.  It's missing key validation and error
-checking.
+In this directory you will find examples and a working bare bones reservation booking system. Not intended for *production* use, and should act as an example to create an even better system. It is missing important validation and error checking. 
 
+##### QUICK GUIDE
+Change `HOST`, `CONSUMER_KEY` and `CONSUMER_SECRET` within `Cart.php` file, this information can be obtained via your Checkfront account.
 
-index.php
----------
 
-The first page fetches available inventory based on the selected date (defaults to today) and 
-allows you to add multiple items to your session.
+### index.php
 
-API calls:
+Default page fetches available inventory based on the selected date (defaults to today) and allows you to add multiple items.
+
+**API calls:**
 
 ```
 booking/session
 item
 ```
 
-create.php
-----------
-
-The create booking page is passed the cart id and the booking form fields are requested from
-Checkfront and rendered on the page. 
+### create.php
 
-Once a successful booking/create call has been completed, a url will be returned in the response.  The 
-url can differ depending on the booking and your configuration.
+Booking form fields are requested from Checkfront via API and rendered on the page. 
 
+Once a successful `booking/create` call has been completed, a url will be returned in the response. The url can differ depending on the booking and your configuration.
 
-API calls:
-
+**API calls:**
+```
 booking/session
 booking/create
 booking/form
+```
 
 
-Form.php
---------
-
+### Form.php
 The form class is an optional helper class that renders the form fields into html.  
 
 
-Cart.php
---------
-
-Main wrapper class that encapsulates the Checkfront API and extends some custom calls. Add API Key & API Secret to this file.
+### Cart.php
+Main wrapper class that encapsulates the Checkfront API and extends some custom calls.