diff --git a/README.md b/README.md index b020207..1beb17c 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,39 @@ Docs related to this repository are located at: 4. GatewayResponse Error / Decline Codes: https://help.rocketgate.com/support/solutions/articles/28000018169-gatewayresponse-error-decline-codes +## Installation Steps + +### 1. Create the RocketGate Package +At the root of your project, create a directory named `RocketGate`. This will serve as the Python package for the RocketGate SDK. + +### 2. Add the SDK File +Copy the `RocketGate.py` file into the newly created `RocketGate` directory. + +### 3. Initialize the Package +In the `RocketGate` directory, create a file named `__init__.py` with the following content: +```python +from .RocketGate import * +``` + +### 4. Import and Use the SDK +Now, you can import the RocketGate package in your Python files and use the SDK as follows: +```python +from RocketGate import * + +# Sample Usage: + +# Create instances of request, response, and service +request = GatewayRequest() +response = GatewayResponse() +service = GatewayService() + +# Set the required merchant credentials +request.Set(GatewayRequest.MERCHANT_ID, 1) +request.Set(GatewayRequest.MERCHANT_PASSWORD, "testpassword") + +# Add more implementation as needed +``` + ## Running integration tests From the root of the project, using your installed Python Interpreter, run the following command: ```shell