From af1924e2895ddc1ee2f11ae82a8b59d0895b773d Mon Sep 17 00:00:00 2001 From: Gregory Oschwald Date: Mon, 24 Jun 2013 11:43:56 -0700 Subject: [PATCH] Clean up markdown a bit --- README.md | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 330eb9c..41dd57e 100644 --- a/README.md +++ b/README.md @@ -53,26 +53,34 @@ this API with the Telephone Verification service. These scripts can be run from the shell. -## API Documentation for minFraud service ## +## Usage ## + +```php $ccfs = new CreditCardFraudDetection; - This creates a new CreditCardFraudDetection object +$ccfs->input($hash); +$ccfs->query(); +$hash = $ccfs->output(); + +``` +### $ccfs->isSecure ### -$ccfs->isSecure - If isSecure is set to 0 then it uses regular HTTP. - If isSecure is set to 1 then it uses Secure HTTPS (requires Curl PHP binding) +If isSecure is set to 0 then it uses regular HTTP. If isSecure is set to 1 +then it uses Secure HTTPS (requires Curl PHP binding) -$ccfs->input($hash) - Takes a hash and uses it as input for the server. - See http://dev.maxmind.com/minfraud/ for details on input fields. +### $ccfs->input($hash) ### -$ccfs->query(); +Takes a hash and uses it as input for the server. See +http://dev.maxmind.com/minfraud/ for details on input fields. + +### $ccfs->query() ### Queries the server with the fields passed to the input method and stores the output. -$hash = $ccfs->output(); - Returns the output from the server. - See http://dev.maxmind.com/minfraud/ for details on output fields. +### $ccfs->output(); + +Returns the output from the server. See http://dev.maxmind.com/minfraud/ +for details on output fields. ## Secure HTTPS ##