init

README.md

@@ -1,54 +1,36 @@
-# OpenCart 3 Module Template
+# Prevent PO Box Address for OpenCart 3
 
-A comprehensive template for developing custom modules and extensions for OpenCart 3.x e-commerce platform.
+An OpenCart 3 extension template that blocks PO Box addresses during checkout and improves shipping address validation.
 
 ## Features
 
-### 🚀 OpenCart 3 Compatibility
-- Fully compatible with OpenCart 3.x versions
-- Uses OCMOD (OpenCart Modification) system for safe modifications
-- No core file changes required
-
-### 📦 Module Structure
-- **install.xml**: OCMOD installation file with modification definitions
-- **upload/**: Directory for module files to be uploaded to OpenCart
-- **install.php**: Optional PHP installation script
-- **install.sql**: Optional database installation script
-
-### 🔄 Automated Releases
-- Integrated Gitea Actions workflow for automatic builds
-- Generates `.ocmod.zip` packages on push to main branch
-- Extracts metadata from `install.xml` for versioning
-- Ready-to-install extension packages
-
-### 🛠️ Development Tools
-- XML-based modification system
-- Template structure for rapid module development
-- CI/CD pipeline for quality assurance
-- Version management through install.xml
+- Prevents PO Box addresses in shipping and billing forms
+- Works with OpenCart 3.x and the OCMOD modification system
+- No core file edits required
+- Easy to install as a `.ocmod.zip` extension package
+- Includes a ready-to-use `install.xml` definition and upload package structure
 
 ## Installation
 
-1. Clone this repository
-2. Customize the `install.xml` with your module details:
-   - Set `<name>`, `<code>`, and `<version>`
-   - Add your modifications in the `<file>` sections
-3. Place your module files in the `upload/` directory
-4. Add installation scripts if needed (`install.php`, `install.sql`)
-5. Push to your repository to trigger automatic release build
+1. Download or clone this repository.
+2. Open the OpenCart admin panel and go to `Extensions > Installer`.
+3. Upload the generated `.ocmod.zip` package.
+4. Go to `Extensions > Modifications` and click `Refresh`.
+5. Open `Extensions > Extensions`, choose `Shipping` or the appropriate extension type, and install the module if needed.
+
+## Setup
+
+1. Customize `install.xml` if required:
+   - Update `<name>`, `<code>`, and `<version>`
+   - Adjust the address validation rules in the modification definitions
+2. Place any additional files in the `upload/` directory for packaging.
+3. If you add install scripts, include `install.php` or `install.sql`.
 
 ## Usage
 
-### For Module Developers
-1. Use this template as a starting point for new OpenCart modules
-2. Define your modifications in `install.xml`
-3. Add custom files to `upload/` directory
-4. Test locally before deploying
-
-### For Store Owners
-1. Download the generated `.ocmod.zip` from releases
-2. Upload via OpenCart's Extension Installer
-3. Install and configure the module through admin panel
+- After installation, checkout address fields are validated for PO Box patterns.
+- Users attempting to enter a PO Box address will be prompted to use a street address instead.
+- Test on a development store before deploying to production.
 
 ## Requirements
 
@@ -60,9 +42,8 @@ A comprehensive template for developing custom modules and extensions for OpenCa
 ## Author
 
 **Mohamed Youssef**  
-Website: [my-dev.pro](https://my-dev.pro)  
-Email: Contact through website
+Website: [my-dev.pro](https://my-dev.pro)
 
 ## License
 
-This template is provided as-is for OpenCart module development. Please check individual module licenses for usage terms.
+This extension template is provided as-is for OpenCart module development. Review and adapt it to your own store policies and licensing needs.