Updated documentation

Author: alexbhr

README.md

@@ -1,36 +1,35 @@
 [![codecov](https://codecov.io/gh/zotapay/python-sdk/branch/master/graph/badge.svg?token=5L1EYONUCU)](https://codecov.io/gh/zotapay/python-sdk)
 ![Python Matrix Test](https://github.com/zotapay/python-sdk/workflows/Python%20Matrix%20Test/badge.svg)
 
-## `zotapaysdk` 
-### Official Python REST API SDK 
+# Official Python REST API SDK
 This is the **official** page of the [Zotapay](http://www.zotapay.com) Python SDK. It is intended to be used by 
 developers who run modern Python applications and would like to integrate our next generation payments platform.
 
 
-### REST API Docs
+## REST API Docs
 
 > **[Official Deposit Documentation](https://doc.zotapay.com/deposit/1.0/#introduction)**
 
 > **[Official Payout Documentation](https://doc.zotapay.com/payout/1.0/#introduction)**
 
 
-#### Introduction
+## Introduction
 This Python SDK provides all the necessary methods for integrating the Zotapay Merchant API. 
 This SDK is to be used by clients, as well as all the related eCommerce plugins for Python applications.
 
 The SDK covers all available functionality that ZotaPay's Merchant API exposes.
 
-#### Requirements
+### Requirements
 * A functioning Zotapay Sandbox or Production account and related credentials
 * Python 3.5 (or higher)
 
-#### Installation
+### Installation
 ```sh
 pip install zotapaysdk
 ```
 
 
-#### Configuration
+## Configuration
 
 [API CONFIGURATION DOCS](https://doc.zotapay.com/deposit/1.0/?python#before-you-begin)
 
@@ -41,7 +40,7 @@ Credentials for the SDK can be passed in 3 different ways:
 
 This part of the documentation will guide you on how to configure and use this SDK.
 
-##### Before you begin
+### Before you begin
 
 To use this API, obtain the following credentials from Zotapay:
 
@@ -53,16 +52,16 @@ EndpointID	        One or more unique endpoint identifiers to use in API request
 
 Contact [Zotapay](https://zotapay.com/contact/) to start your onboarding process and obtain all the credentials.
 
-##### API Url
+### API Url
 There are two environments to use with the Zotapay API:
 
 > Sandbox environment, used for integration and testing purposes.
->>`https://api.zotapay-sandbox.com`	        
+`https://api.zotapay-sandbox.com`
 
 > Live environment.
->>`https://api.zotapay.com` or `https://mg-api.zotapay.com`	
+`https://api.zotapay.com`
 
-##### Configuration in the code
+### Configuration in the code
 
 The implementation fo the Zotapay API SDK depends on creating an instance of the `MGClient`. First priority 
 configuration is the one passed to the client itself.
@@ -79,7 +78,7 @@ client = zotapaysdk.MGClient(
 
 Passing configuration to the client itself is best when supporting multiple clients.
 
-##### Environment variables configuration
+### Environment variables configuration
 
 There are 4 environment variables that need to be set for the API SDK to be configured correctly:
 
@@ -91,7 +90,7 @@ ZOTAPAY_REQUEST_URL             - https://api.zotapay-sandbox.com or https://api
 ```
 
 
-##### Configuration file
+### Configuration file
 Configuration parameters can be passed through a `.mg_env` file placed in the user's home directory.
 
 The structure of the files follows Python's [configparser](https://docs.python.org/3/library/configparser.html)
@@ -105,19 +104,19 @@ endpoint_id=<EndpointID as received from Zotapay>,
 request_url=<MGClient.LIVE_API_URL or MGClient.SANDBOX_API_URL or "https://api.zotapay-sandbox.com"...>
 ```
 
-#### Usage
+## Usage
 In order to use the SDK we need to instantiate a client:
-```
+```python
 from zotapaysdk.client import MGClient
 
 mg_client = MGClient()
 ```
 
-##### Deposit
+### Deposit
 
 A deposit request can be generated in two different ways:
 
-```
+```python
 from zotapaysdk.mg_requests import MGDepositRequest
 
 example_deposit_request_with_kwargs = MGDepositRequest(
@@ -142,10 +141,10 @@ example_deposit_request_with_kwargs = MGDepositRequest(
 
 ```
 
-or
+or alternatively
 
 
-```
+```python
 example_deposit_request = MGDepositRequest(). \
     set_merchant_order_id("QvE8dZshpKhaOmHY"). \
     set_merchant_order_desc("Test order"). \
@@ -168,14 +167,15 @@ example_deposit_request = MGDepositRequest(). \
 
 Sending the request to Zotapay happens through the client:
 
-```
+```python
 deposit_response = mg_client.send_deposit_request(example_deposit_request)
 print("Deposit Request is " + str(deposit_response.is_ok))
 ```
 
 In order to send a `Credit Card Deposit` we need to append the appropriate [Credit Card Params](https://doc.zotapay.com/deposit/1.0/?python#card-payment-integration-2)
 which is achieved through sending a `MGCardDepositRequest`
-```
+
+```python
 example_cc_deposit_request = MGCardDepositRequest(
     merchant_order_id="QvE8dZshpKhaOmHY",
     merchant_order_desc="Test order",
@@ -207,19 +207,19 @@ deposit_response = mg_client.send_deposit_request(example_cc_deposit_request)
 print("Deposit Request is " + str(deposit_response.is_ok))
 ```
 
-##### Working with `Deposit Response`
+### Working with `Deposit Response`
 Each deposit attempt against a Zotapay returns either a `MGDepositResponse` or `MGCardDepositResponse`.
 
 The above objects are simply a wrapper around the standard HTTP response as described [here](https://doc.zotapay.com/deposit/1.0/?python#issue-a-deposit-request).
 
 The response classes contain an additional helper method that validates the signature of the response when provided with a `merchant_secret_key`
 
-#### Payout
+## Payout
 Sending a payout request is almost identical to sending a deposit request.
 
 The request is built:
 
-```
+```python
 from zotapaysdk.mg_requests import MGPayoutRequest
 
 example_payout_request = \
@@ -248,18 +248,18 @@ example_payout_request = \
 
 The client returns `MGPayoutResponse` which is again a wrapper around the standard HTTP response.
 
-#### Callbacks
+## Callbacks
 `MGCallback` is a class that parses the raw HTTP Request sent from Zotapay to the configured endpoint. It's purpose
 is to make working with callbacks manageable.
 
 
-#### Validations
+## Validations
 The `MGRequest` class implements a `validate()` method which can be used for parameter validation of the request
 offline before the request is being sent. It's purpose is to check whether all the values passsed to the different
 parameters is in-line with what Zotapay's endpoint expects. See the API DOCS for more info and guidance about the
 format of the different parameters.
 
-### Test Coverage
+## Test Coverage
 
 [![codecov](https://codecov.io/gh/zotapay/python-sdk/graphs/tree.svg?width=650&height=150&src=pr&token=5L1EYONUCU)](https://codecov.io/gh/zotapay/python-sdk/)
 

docs/RELEASING.md

@@ -0,0 +1,3 @@
+## Releasing the package
+
+In order to release the package, commit anything to master and a new tag should be created. Go to releases and simply publish the latest draft release!