standardize readme format and info across repos

adavidw · adavidw · commit 93b66426ac94 · 2017-07-03T16:41:04.000-06:00
diff --git a/README.md b/README.md
@@ -5,26 +5,32 @@
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/AuthorizeNet/sdk-python/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/AuthorizeNet/sdk-python/?branch=master)
 [![PyPI](https://img.shields.io/pypi/v/authorizenet.svg)](https://badge.fury.io/py/authorizenet)
 
-`pip install authorizenet`
 
+## Requirements
 
-## Prerequisites
+* Python 2.7 or greater
+* OpenSSL 1.0.2 or greater
+* An Authorize.Net account (see Registration & Configuration section below)
 
-- Python 2.7 or greater
-- OpenSSL 1.0.2 or greater
 
-We'll be ensuring this SDK is compatible with Python 2.7+, 3.2+ and PyPy but we're primarily testing against Python 2.7 so that's the current prerequisite.
+We'll be ensuring this SDK is compatible with Python 2.7+, 3.2+ and PyPy but we're primarily testing against Python 2.7.
 
 
 ## Installation
-To install AuthorizeNet
+
+To install the AuthorizeNet Python SDK:
 
 `pip install authorizenet`
 
 
-## Registration & Configuration
+## Registration & Configuration {#Registration}
 
+Use of this SDK and the Authorize.Net APIs requires having an account on our system
 Get a sandbox account at https://developer.authorize.net/sandbox  
+
+
+### Authentication
+
 Set your API credentials:  
 
 ```python
@@ -34,56 +40,16 @@ Set your API credentials:
 ```
 
 
-## Usage
-See our sample code repository at https://github.com/AuthorizeNet/sample-code-python 
-
-For the simplest "Hello World" example, paste this into a file called charge-credit-card.py and run:
-
-```python
-from authorizenet import apicontractsv1
-from authorizenet.apicontrollers import *
-from decimal import *
-
-merchantAuth = apicontractsv1.merchantAuthenticationType()
-merchantAuth.name = 'YOUR_LOGIN_ID'
-merchantAuth.transactionKey = 'YOUR_TRANSACTION_KEY'
-
-creditCard = apicontractsv1.creditCardType()
-creditCard.cardNumber = "4111111111111111"
-creditCard.expirationDate = "2020-12"
-
-payment = apicontractsv1.paymentType()
-payment.creditCard = creditCard
-
-transactionrequest = apicontractsv1.transactionRequestType()
-transactionrequest.transactionType = "authCaptureTransaction"
-transactionrequest.amount = Decimal ('1.55')
-transactionrequest.payment = payment
-
-
-createtransactionrequest = apicontractsv1.createTransactionRequest()
-createtransactionrequest.merchantAuthentication = merchantAuth
-createtransactionrequest.refId = "MerchantID-0001"
-
-createtransactionrequest.transactionRequest = transactionrequest
-createtransactioncontroller = createTransactionController(createtransactionrequest)
-createtransactioncontroller.execute()
-
-response = createtransactioncontroller.getresponse()
-
-if (response.messages.resultCode=="Ok"):
-	print "Transaction ID : %s" % response.transactionResponse.transId
-else:
-	print "response code: %s" % response.messages.resultCode
-
-```
 ### Setting Production or Sandbox Environments  
 To set the environment use the setenvironment method on the controller before executing.  E.g. for the example above:
 ```python
 # Defaults to constants.SANDBOX for sandbox testing
 createtransactioncontroller.setenvironment(constants.PRODUCTION)
 ```
 
+## Usage
+See our sample code repository at https://github.com/AuthorizeNet/sample-code-python 
+
 ## Building and Testing Source Code
 
 Requirements
@@ -105,3 +71,7 @@ Testing
 
 `>nosetests`
 
+
+## License
+
+This repository is destributed under a proprietary license. See the provided [LICENSE.txt] file.
