Simplify README and add iframe info

Author: Grace Yim

README.md

@@ -1,49 +1,34 @@
-# ToopherPHP [![Build
-Status](https://travis-ci.org/toopher/toopher-php.png?branch=master)](https://travis-ci.org/toopher/toopher-php)
+# ToopherPHP [![Build Status](https://travis-ci.org/toopher/toopher-php.png?branch=master)](https://travis-ci.org/toopher/toopher-php)
 
-#### Introduction
 ToopherPHP is a Toopher API library that simplifies the task of interfacing with the Toopher API from PHP code.  This project includes all the dependency libraries and handles the required OAuth and JSON functionality so you can focus on just using the API.
 
-#### Learn the Toopher API
-Make sure you visit [http://dev.toopher.com](http://dev.toopher.com) to get acquainted with the Toopher API fundamentals.  The documentation there will tell you the details about the operations this API wrapper library provides.
+### PHP Version
+\>=5.3.0
 
-#### OAuth Authentication
+### Documentation
+Make sure you visit [https://dev.toopher.com](https://dev.toopher.com) to get acquainted with the Toopher API fundamentals.  The documentation there will tell you the details about the operations this API wrapper library provides.
 
-The first step to accessing the Toopher API is to sign up for an account at the development portal [http://dev.toopher.com](http://dev.toopher.com) and create a "requester". When that process is complete, your requester is issued OAuth 1.0a credentials in the form of a consumer key and secret. Your key is used to identify your requester when Toopher interacts with your customers, and the secret is used to sign each request so that we know it is generated by you.  This library properly formats each request with your credentials automatically.
+## ToopherApi Workflow
 
-#### The Toopher Two-Step
-Interacting with the Toopher web service involves two steps: pairing, and authenticating.
-
-##### Pair
-Before you can enhance your website's actions with Toopher, your customers will need to pair their phone's Toopher app with your website.  To do this, they generate a unique, nonsensical "pairing phrase" from within the app on their phone.  You will need to prompt them for a pairing phrase as part of the Toopher enrollment process.  Once you have a pairing phrase, just send it to the Toopher API along with your requester credentials and we'll return a pairing ID that you can use whenever you want to authenticate an action for that user.
-
-##### Authenticate
-You have complete control over what actions you want to authenticate using Toopher (for example: logging in, changing account information, making a purchase, etc.).  Just send us the user's pairing ID, a name for the terminal they're using, and a description of the action they're trying to perform and we'll make sure they actually want it to happen.
-
-#### Librarified
-This library makes it super simple to do the Toopher two-step.  Check it out:
+### Step 1: Pair
+Before you can enhance your website's actions with Toopher, your customers will need to pair their mobile device's Toopher app with your website.  To do this, they generate a unique pairing phrase from within the app on their mobile device.  You will need to prompt them for a pairing phrase as part of the Toopher enrollment process.  Once you have a pairing phrase, just send it to the Toopher web service along with your requester credentials and we'll return a pairing ID that you can use whenever you want to authenticate an action for that user.
 
 ```php
 require_once("toopher_api.php");
 
 // Create an API object using your credentials
 $toopherApi = new ToopherApi("<your consumer key>", "<your consumer secret>");
 
-// Step 1 - Pair with their phone's Toopher app
-// With pairing phrase
+// Step 1 - Pair with their mobile device's Toopher app
 $pairing = $toopherApi->pair("username@yourservice.com", "pairing phrase");
-// With SMS
-$pairing = $toopherApi->pair("username@yourservice.com", "555-555-5555");
-// With QR code
-$pairing = $toopherApi->pair("username@yourservice.com");
+```
 
+### Step 2: Authenticate
+You have complete control over what actions you want to authenticate using Toopher (logging in, changing account information, making a purchase, etc.).  Just send us the username or pairing ID and we'll make sure they actually want it to happen. You can also choose to provide the following optional parameters: terminal name, requester specified ID and action name (*default: "Log in"*).
 
+```php
 // Step 2 - Authenticate a log in
-// With a pairing id and terminal name
-$authRequest = $toopherApi->authenticate($pairing->id, "my computer");
-// With a username, terminal name and requester specified terminal id
-$authRequest = $toopherApi->authenticate("username", "my computer", "requester specified id");
-
+$authRequest = $toopherApi->authenticate("username", "my computer");
 
 // Once they've responded you can then check the status
 $authRequest->refreshFromServer();
@@ -52,33 +37,65 @@ if ($authRequest->pending == false && $authRequest->granted == true) {
 }
 ```
 
-#### Dependencies
-Toopher manages dependencies with [composer](http://getcomposer.org).  To ensure all dependencies are up-to-date, execute the following command:
-```shell
-$ composer install
+## ToopherIframe Workflow
+
+### Step 1: Embed a request in an IFRAME
+1. Generate an authentication URL by providing a username.
+2. Display a webapage to your user that embeds this URL within an `<iframe>` element.
+
+```php
+require_once("toopher_api.php")
+
+// Create an API object using your credentials
+$iframeApi = new ToopherIframe("<your consumer key>", "<your consumer secret>");
+
+$authIframeUrl = $iframeApi->getAuthenticationUrl("username@yourservice.com");
+
+// Add an <iframe> element to your HTML:
+// <iframe id="toopher-iframe" src=authIframeUrl />
 ```
-from the root directory the package (the same directory that this README is located in)
 
-#### Handling Errors
+### Step 2: Validate the postback data
+
+The simplest way to validate the postback data is to call `isAuthenticationGranted` to check if the authentication request was granted.
+
+```php
+// Retrieve the postback data as a string from POST parameter 'iframe_postback_data'
+
+// Returns boolean indicating if authentication request was granted by user
+$authenticationRequestGranted = $iframeApi->isAuthenticationGranted(postback_data)
+
+if ($authenticationRequestGranted) {
+    // Success!
+}
+```
+
+### Handling Errors
 If any request runs into an error a `ToopherRequestException` will be thrown with more details on what went wrong.
 
-#### Example code
-Check out demo/toopher_demo.php for an example program that walks you through the whole process!  Simply execute the script as follows:
+### Demo
+Check out `demo/toopher_demo.php` for an example program that walks you through the whole process!  Simply run the command below:
 ```shell
 $ php demo/toopher_demo.php
 ```
-To avoid being prompted for your Toopher API key and secret, you can define them in the $TOOPHER_CONSUMER_KEY and $TOOPHER_CONSUMER_SECRET environment variables
 
-#### Tests
-To run all unit tests:
+## Contributing
+### Dependencies
+Toopher manages dependencies with [composer](http://getcomposer.org).  To ensure all dependencies are up-to-date run the command below from the root directory:
+```shell
+$ composer install
+```
+
+### Tests
+To run the tests enter:
 ```shell
 $ phpunit test
 ```
-Note: `phpunit` may be found in `vendor/bin/php` so your test command
-would be
+*Note: `phpunit` may be found in `vendor/bin/php` so your test command
+would be:*
 ```shell
 $ vendor/bin/phpunit test
 ```
 
-#### License
-ToopherPHP is licensed under the MIT License. See LICENSE.txt for the full license text.
+## License
+ToopherPHP is licensed under the MIT License. See LICENSE.txt for the full text.