Updated markdown documentation

README.md

@@ -1,10 +1,9 @@
-
 # MPESA SDK for Rust
 
-This crate provides a streamlined interface for integrating **M-Pesa**, a widely used *mobile money service*, into your Rust applications. The SDK focuses on both **safety** and **speed**, making it easy for developers alike to interact with **Safaricom's Daraja**/**M-PESA API**.
+This crate provides a streamlined interface for integrating **M-Pesa**, a widely used _mobile money service_, into your Rust applications. The SDK focuses on both **safety** and **speed**, making it easy for developers to interact with **Safaricom's Daraja**/**M-PESA API**.
 
-**Author:** *Irfan Ghat*  
-**License:** *MIT*
+**Author:** _Irfan Ghat_  
+**License:** _MIT_
 
 ## Installation
 
@@ -13,13 +12,31 @@ To use the **MPESA SDK** in your Rust project, add the following to your `Cargo.
 ```toml
 [dependencies]
 tokio = { version = "1", features = ["full"] }
-mpesa_sdk = "0.1.0"  # Current version [BETA] 
+mpesa_sdk = "0.1.1"  # Current version [BETA]
 ```
+
 ## Modules
 
 -   `authentication`: Handles authentication with the MPESA API.
 -   `lipa_na_mpesa`: Manages Lipa na MPESA transactions.
 
+## Environment Management
+
+The SDK supports configuration through environment variables, making it easier to manage different environments (e.g., sandbox, production).
+
+### Environment Variables
+
+Set the following environment variables in your `.env` file or directly in your environment:
+
+```env
+USAGE_TOKEN=YOUR_USAGE_TOKEN
+ENVIRONMENT=sandbox # For production use live.
+AUTH_TOKEN=YOUR_AUTH_TOKEN
+BUSINESS_SHORT_CODE=YOUR_SHORT_CODE
+CALLBACK_URL=https://mydomain.com/path
+PASSKEY=YOUR_PASS_KEY
+``` 
+
 ## Example Usage
 
 Below are examples of how to use the Authentication and Lipa na MPESA services provided by the SDK.
@@ -41,6 +58,7 @@ async fn main() {
     }
 }
 ```
+
 ### Lipa na MPESA Service
 
 To initiate a Lipa na MPESA transaction, use the `LipaNaMpesaService::init` method. Provide the necessary parameters such as amount, phone number, company name, and transaction description.
@@ -63,7 +81,8 @@ async fn main() {
         Err(e) => eprintln!("Lipa na MPESA transaction failed: {:?}", e),
     }
 }
-```
+``` 
+
 ## Detailed Module Descriptions
 
 ### Authentication Module
@@ -86,7 +105,8 @@ async fn authenticate() {
         Err(e) => eprintln!("Authentication failed: {:?}", e),
     }
 }
-```
+``` 
+
 ### Lipa na MPESA Module
 
 The `lipa_na_mpesa` module handles the Lipa na MPESA transactions. This service allows you to initiate a payment request to a customer's phone.
@@ -115,17 +135,59 @@ async fn initiate_payment() {
 }
 ``` 
 
+## Configuration Example
+
+Below is an example of how to configure the Lipa na MPESA service with the provided environment variables:
+
+```rust
+use service_requests::authentication::AuthenticationService;
+use service_requests::lipa_na_mpesa::LipaNaMpesaService;
+use endpoints::ServiceEndpoints;
+use std::env;
+
+#[tokio::main]
+async fn main() {
+    // Load environment variables
+    dotenv::dotenv().ok();
+    let environment = env::var("ENVIRONMENT").unwrap_or_else(|_| "sandbox".to_string());
+    let business_short_code = env::var("BUSINESS_SHORT_CODE").expect("BUSINESS_SHORT_CODE must be set");
+    let callback_url = env::var("CALLBACK_URL").expect("CALLBACK_URL must be set");
+    let passkey = env::var("PASSKEY").expect("PASSKEY must be set");
+
+    // Configure MPESA Express URL
+    let urls = ServiceEndpoints::new();
+    let mpesa_express_url = format!("{}{}", environment, &urls.MpesaExpress.url);
+
+    // Authenticate
+    let auth_response = AuthenticationService::init().await.unwrap();
+    let auth_token = format!("Bearer {}", auth_response.access_token);
+
+    // Initiate Lipa na MPESA transaction
+    let lipa_na_mpesa_result = LipaNaMpesaService::init(
+        1, // Amount to transact
+        254123456789, // Phone number in international format
+        "CompanyNameLTD".to_string(), // Company name
+        "The payment has been processed successfully".to_string() // Transaction description
+    ).await;
+
+    match lipa_na_mpesa_result {
+        Ok(transaction_details) => println!("Transaction successful: {:?}", transaction_details),
+        Err(e) => eprintln!("Transaction failed: {:?}", e),
+    }
+}
+``` 
+
 ## Future Plans
 
 ### Current and Upcoming Implementations
 
-Currently, the SDK exposes functions for **Consumer-to-Business** (*C2B*) interactions, allowing for payments from customers to businesses. This includes services like Lipa na MPESA.
+Currently, the SDK exposes functions for **Consumer-to-Business** (_C2B_) interactions, allowing for payments from customers to businesses. This includes services like Lipa na MPESA.
 
-In the near *future*, **Business-to-Business** (*B2B*) transactions will also be implemented. This will enable transactions between businesses, expanding the capabilities of the SDK to cover more use cases.
+In the near _future_, **Business-to-Business** (_B2B_) transactions will also be implemented. This will enable transactions between businesses, expanding the capabilities of the SDK to cover more use cases.
 
 ### Secure Callback Endpoint
 
-Additionally, users who opt in will have a secure endpoint for the callback URL generated and configured on **Render Cloud** (*@render-inc*). This endpoint will handle the ***JSON dumps*** after all transactions, reducing the effort required to set up a secure endpoint/domain.
+Additionally, users who opt in will have a secure endpoint for the callback URL generated and configured on **Render Cloud** (_@render-inc_). This endpoint will handle the _**JSON dumps**_ after all transactions, reducing the effort required to set up a secure endpoint/domain.
 
 ## Contributing
 
@@ -137,4 +199,4 @@ This project is licensed under the MIT License. See the LICENSE file for details
 
 ## Support
 
-For any questions or support, please contact the author at irfanghat@gmail.com.
+For any questions or support, please contact the author at irfanghat@gmail.com.

src/main.rs

@@ -31,17 +31,17 @@ async fn main() {
     ////////////////////////////////////////////
     //// Initiate [Authentication] service ////
     //////////////////////////////////////////
-    let auth_result = AuthenticationService::init();
-    println!("{:?}", auth_result.await.unwrap());
+    // let auth_result = AuthenticationService::init();
+    // println!("{:?}", auth_result.await.unwrap());
 
     /////////////////////////////////////////
     //// Initiate [LipaNaMpesa] service ////
     ////////////////////////////////////////
-    // let lipa_na_mpesa_result = LipaNaMpesaService::init(
-    //     1,
-    //     254123456789,
-    //     "CompanyNameLTD".to_string(),
-    //     "The payment has been processed successfully".to_string(),
-    // );
-    // println!("{:?}", lipa_na_mpesa_result.await);
+    let lipa_na_mpesa_result = LipaNaMpesaService::init(
+        1,
+        254123456789,
+        "CompanyNameLTD".to_string(),
+        "The payment has been processed successfully".to_string(),
+    );
+    println!("{:?}", lipa_na_mpesa_result.await);
 }