adding readme for future reference

README.md

@@ -1,16 +1,52 @@
-# qpay
+# qpay-peak-flutter
 
-A new Flutter project.
+## Switch from Test to Live Environment
 
-## Getting Started
+This project currently reads runtime API settings from `assets/.env` and loads Mastercard Checkout for web from `web/index.html`.
 
-This project is a starting point for a Flutter application.
+Use the checklist below before building for production.
 
-A few resources to get you started if this is your first Flutter project:
+### 1) Update API and simulation flags (`assets/.env`)
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+In `assets/.env`, make sure the active (uncommented) values are set for live:
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+```dotenv
+BASE_URL=https://peakapi.qantra.co.zw/api
+SIMULATE_PAYMENT_SUCCESS=false
+```
+
+Notes:
+- Keep only one active `BASE_URL` line.
+- `SIMULATE_PAYMENT_SUCCESS` must be `false` in live to avoid fake-success payment flows.
+
+### 2) Update Mastercard Checkout script (`web/index.html`)
+
+In `web/index.html`, switch the checkout script from test to live:
+
+```html
+<script src="https://na.gateway.mastercard.com/static/checkout/checkout.min.js"></script>
+```
+
+And ensure the test script is not active:
+
+```html
+<!-- <script src="https://test-gateway.mastercard.com/static/checkout/checkout.min.js"></script> -->
+```
+
+### 3) Quick pre-release verification
+
+Before release, confirm:
+- `assets/.env` points to the live API URL.
+- `assets/.env` has `SIMULATE_PAYMENT_SUCCESS=false`.
+- `web/index.html` loads `na.gateway.mastercard.com` (not `test-gateway.mastercard.com`).
+
+## Switch back to Test
+
+To return to test:
+- Restore the test `BASE_URL` in `assets/.env`.
+- Set `SIMULATE_PAYMENT_SUCCESS=true` (only if needed for local testing).
+- Re-enable the test checkout script in `web/index.html`.
+
+## Source of Truth
+
+If environment settings change in future, update this README section together with `assets/.env` and `web/index.html` so release steps stay accurate.