update readme
This commit is contained in:
parent
9e856dc4a9
commit
aa2a8c9736
102
README.md
Normal file
102
README.md
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
=== Hesabix for WooCommerce ===
|
||||
Contributors: Mohammad Rezai
|
||||
Tags: accounting, hesabix, woocommerce, jalali, invoice, integration, persian
|
||||
Requires at least: 5.2
|
||||
Tested up to: 6.6.1
|
||||
Requires PHP: 7.4
|
||||
Stable tag: 1.0.0
|
||||
License: GPLv3 or later
|
||||
License URI: https://www.gnu.org/licenses/gpl-3.0.html
|
||||
|
||||
Modern, localized, and secure WooCommerce integration with Hesabix Cloud Accounting. Featuring full Jalali calendar support, real-time data sync, and advanced customization for Persian e-commerce.
|
||||
|
||||
== 🧩 Overview ==
|
||||
|
||||
**Hesabix for WooCommerce** connects your online store with [Hesabix](https://hesabix.com), the powerful cloud-based accounting system built for Persian businesses.
|
||||
|
||||
From real-time product, order, and customer sync to full Persian date support, this plugin is everything a modern Iranian online store needs to automate its bookkeeping.
|
||||
|
||||
== ✨ Features ==
|
||||
|
||||
### 🔗 Seamless Integration
|
||||
- Automatically syncs products, orders, and customers with your Hesabix account
|
||||
- One-click synchronization for bulk data
|
||||
- AJAX-powered UI for responsive operations
|
||||
|
||||
### 📅 Persian Calendar Support
|
||||
- Native Jalali calendar UI
|
||||
- Gregorian ↔ Jalali date conversion
|
||||
- Custom date filters and ranges
|
||||
|
||||
### 💼 Smart Customer Handling
|
||||
- Auto-create customers in Hesabix from WooCommerce orders
|
||||
- National ID, economic code, and business info fields
|
||||
- Custom checkout fields with flexible validation
|
||||
|
||||
### 🧾 Invoice & Finance Management
|
||||
- Instant invoice generation on new orders
|
||||
- Freight and shipping cost handling
|
||||
- Payment method mapping
|
||||
|
||||
### ⚙️ Developer Tools
|
||||
- Clean, modular code with hooks and filters
|
||||
- Extendable data mappers for products and customers
|
||||
- Debug logs and status monitoring
|
||||
|
||||
### 🌐 Localization & UI
|
||||
- Fully RTL and Persian language ready
|
||||
- Modern, tabbed admin interface
|
||||
- Responsive and mobile-friendly
|
||||
|
||||
== 🛠️ Installation & Setup ==
|
||||
|
||||
1. Upload the plugin to `/wp-content/plugins/hesabix-woocommerce/`
|
||||
2. Activate via **Plugins > Hesabix for WooCommerce**
|
||||
3. Go to **WooCommerce > Hesabix Settings**
|
||||
4. Enter your API Key (get it from your [Hesabix account](https://app.hesabix.com))
|
||||
5. Test connection and start syncing!
|
||||
|
||||
== ❓ Frequently Asked Questions ==
|
||||
|
||||
**How do I get an API key?**
|
||||
Log in to your Hesabix account and navigate to *Settings > API*. Copy the key and paste it into the plugin settings.
|
||||
|
||||
**Is it compatible with Persian WooCommerce stores?**
|
||||
Yes — fully RTL compatible, Persian translations included, and Jalali calendar support is native.
|
||||
|
||||
**Can I control what data gets synced?**
|
||||
Absolutely — toggle options for each data type and use filters to customize.
|
||||
|
||||
**Does it work with subscription products?**
|
||||
Currently designed for standard WooCommerce orders.
|
||||
|
||||
**Is my data safe?**
|
||||
Yes — we follow WordPress best practices including nonce verification, secure API connections, and local data handling.
|
||||
|
||||
== 🖼️ Screenshots ==
|
||||
|
||||
1. Plugin Dashboard with sync status
|
||||
2. Customer field customization
|
||||
3. Jalali date picker for filtering
|
||||
4. Invoice configuration
|
||||
5. Product linking interface
|
||||
|
||||
== 🌐 Resources ==
|
||||
|
||||
- [Official Website](https://hesabix.com)
|
||||
- [User Guide](https://hesabix.com/school)
|
||||
- [Support](https://hesabix.com/support)
|
||||
|
||||
== 👨💻 Credits ==
|
||||
|
||||
**Developer**: Mohammad Rezai
|
||||
**Website**: [pirouz.xyz](https://pirouz.xyz)
|
||||
|
||||
== 🔐 License ==
|
||||
|
||||
This plugin is licensed under the GPLv3. You are free to modify, distribute, and use it under the terms of the license.
|
||||
|
||||
== 🛡️ Privacy ==
|
||||
|
||||
No personal data is collected by this plugin. All communications are strictly between your WordPress site and Hesabix servers.
|
||||
|
||||
187
README.txt
187
README.txt
|
|
@ -1,187 +0,0 @@
|
|||
=== Hesabix: WooCommerce Integration ===
|
||||
Author: Mohammad Rezai
|
||||
Author url: [Pirouz.xyz](https://pirouz.xyz)
|
||||
Tags: accounting, cloud, hesabix, woocommerce, invoice, sync, persian, jalali
|
||||
Requires at least: 5.2
|
||||
Tested up to: 6.6.1
|
||||
Requires PHP: 7.4
|
||||
Stable tag: 1.0.0
|
||||
License: GPL-3.0+
|
||||
License URI: https://www.gnu.org/licenses/gpl-3.0.html
|
||||
|
||||
Connect your WooCommerce store to Hesabix Online Accounting with advanced features including Jalali calendar support, AJAX operations, and comprehensive synchronization.
|
||||
|
||||
== Description ==
|
||||
|
||||
**Hesabix: WooCommerce Integration** is a powerful plugin that seamlessly connects your WooCommerce store to Hesabix Online Accounting software. This plugin provides comprehensive synchronization capabilities, allowing you to automatically save products, customers, and orders in your Hesabix account while maintaining full control over your data.
|
||||
|
||||
### 🚀 Key Features
|
||||
|
||||
**📊 Advanced Synchronization**
|
||||
- Real-time product synchronization with price and inventory updates
|
||||
- Customer data synchronization with custom field support
|
||||
- Order synchronization with automatic invoice generation
|
||||
- Batch processing for large datasets
|
||||
- Progress tracking with visual indicators
|
||||
|
||||
**🎯 Smart Customer Management**
|
||||
- Automatic customer creation in Hesabix from WooCommerce users
|
||||
- Custom checkout fields with optional/required settings
|
||||
- National ID, Economic Code, Registration Number, and Website fields
|
||||
- Flexible field configuration with radio button controls
|
||||
- AJAX-powered customer updates
|
||||
|
||||
**📅 Jalali Calendar Support**
|
||||
- Native Jalali (Persian) calendar integration
|
||||
- Date range selection with Jalali input fields
|
||||
- Automatic Gregorian-Jalali conversion
|
||||
- Persian date display and validation
|
||||
- Responsive date picker interface
|
||||
|
||||
**⚙️ Advanced Settings & Configuration**
|
||||
- Comprehensive API settings with connection testing
|
||||
- Custom API endpoint configuration
|
||||
- Freight and shipping options
|
||||
- Invoice customization settings
|
||||
- Catalog management options
|
||||
|
||||
**🔄 Real-time Operations**
|
||||
- AJAX-powered operations for smooth user experience
|
||||
- Nonce verification for enhanced security
|
||||
- Progress indicators for long-running operations
|
||||
- Error handling and user feedback
|
||||
- Tab-based interface for organized settings
|
||||
|
||||
**📱 Responsive Design**
|
||||
- Mobile-friendly admin interface
|
||||
- Responsive tables and forms
|
||||
- Touch-friendly controls
|
||||
- Optimized for all screen sizes
|
||||
|
||||
**🌐 Multi-language Support**
|
||||
- Persian (Farsi) language support
|
||||
- Translation-ready architecture
|
||||
- Customizable text strings
|
||||
- RTL layout support
|
||||
|
||||
### 🔧 Technical Features
|
||||
|
||||
**Security & Performance**
|
||||
- WordPress nonce verification on all AJAX endpoints
|
||||
- Optimized JavaScript with combined and minified files
|
||||
- Efficient database operations
|
||||
- Error logging and debugging capabilities
|
||||
|
||||
**Developer Friendly**
|
||||
- Clean, well-documented code
|
||||
- Modular architecture
|
||||
- Hook and filter support
|
||||
- Comprehensive logging system
|
||||
|
||||
### 📋 System Requirements
|
||||
|
||||
- WordPress 5.2 or higher
|
||||
- WooCommerce 3.0.0 or higher
|
||||
- PHP 7.4 or higher
|
||||
- MySQL 5.6 or higher
|
||||
- Active internet connection for Hesabix API
|
||||
|
||||
### 🎯 Use Cases
|
||||
|
||||
**For E-commerce Businesses**
|
||||
- Automate accounting processes
|
||||
- Maintain accurate inventory records
|
||||
- Generate invoices automatically
|
||||
- Track customer information
|
||||
- Sync product catalogs
|
||||
|
||||
**For Accountants**
|
||||
- Real-time financial data access
|
||||
- Automated bookkeeping
|
||||
- Comprehensive reporting
|
||||
- Multi-store management
|
||||
|
||||
**For Developers**
|
||||
- Extensible plugin architecture
|
||||
- Custom field integration
|
||||
- API customization options
|
||||
- Hook and filter system
|
||||
|
||||
== Installation ==
|
||||
|
||||
### Method 1: WordPress Admin (Recommended)
|
||||
1. Go to **Plugins > Add New** in your WordPress admin
|
||||
2. Search for "Hesabix WooCommerce"
|
||||
3. Click **Install Now** and then **Activate**
|
||||
|
||||
### Method 2: Manual Installation
|
||||
1. Download the plugin files
|
||||
2. Upload to `/wp-content/plugins/hesabixWCPlugin/` directory
|
||||
3. Activate the plugin through the **Plugins** screen in WordPress
|
||||
4. Go to **Settings > Hesabix** to configure the plugin
|
||||
|
||||
### Initial Setup
|
||||
1. **Get Hesabix API Key**: Visit [app.hesabix.com](https://app.hesabix.com) and sign up for a free account
|
||||
2. **Configure Business**: Choose your business in Hesabix settings
|
||||
3. **Get API Key**: Go to Settings > API in your Hesabix account
|
||||
4. **Enter API Key**: Paste your API key in the plugin settings
|
||||
5. **Test Connection**: Use the "Test Connection" button to verify setup
|
||||
|
||||
== Frequently Asked Questions ==
|
||||
|
||||
**Q: How do I get my Hesabix API key?**
|
||||
A: Sign up at hesabix.com, go to your business settings, and find the API section.
|
||||
|
||||
**Q: Can I use custom fields for customers?**
|
||||
A: Yes! The plugin supports custom fields like National ID, Economic Code, and more.
|
||||
|
||||
**Q: Does the plugin support Persian dates?**
|
||||
A: Yes, the plugin includes full Jalali calendar support with automatic conversion.
|
||||
|
||||
**Q: How do I sync my existing products?**
|
||||
A: Use the "Import Products" feature in the plugin admin panel.
|
||||
|
||||
**Q: Can I customize invoice settings?**
|
||||
A: Yes, you can configure freight options, payment methods, and invoice templates.
|
||||
|
||||
**Q: Is the plugin secure?**
|
||||
A: Yes, all AJAX operations include nonce verification and follow WordPress security standards.
|
||||
|
||||
**Q: Does it work with WooCommerce subscriptions?**
|
||||
A: The plugin is designed for standard WooCommerce orders and products.
|
||||
|
||||
**Q: Can I export my data?**
|
||||
A: Yes, the plugin includes comprehensive export features for products, customers, and orders.
|
||||
|
||||
== Screenshots ==
|
||||
|
||||
1. **Dashboard Overview** - Main plugin dashboard with statistics and quick actions
|
||||
2. **API Settings** - Configure your Hesabix API connection
|
||||
3. **Synchronization** - Manage product, customer, and order synchronization
|
||||
4. **Customer Settings** - Configure custom fields and customer management
|
||||
5. **Invoice Settings** - Customize invoice generation and freight options
|
||||
6. **Product Management** - Link WooCommerce products to Hesabix items
|
||||
7. **Order Management** - View and manage synchronized orders
|
||||
8. **Log Management** - Monitor plugin activity and troubleshoot issues
|
||||
|
||||
== Support ==
|
||||
|
||||
**Documentation**: Visit [hesabix.com](https://hesabix.com) and check the "Accounting School" section for detailed guides.
|
||||
|
||||
**Support**: For technical support, please contact the plugin developer.
|
||||
|
||||
**Community**: Join the Hesabix community for tips and best practices.
|
||||
|
||||
== Credits ==
|
||||
|
||||
**Developer**: Mohammad Rezai ([pirouz.xyz](https://pirouz.xyz))
|
||||
|
||||
**Special Thanks**: To the WordPress and WooCommerce communities for their excellent platforms.
|
||||
|
||||
== License ==
|
||||
|
||||
This plugin is licensed under the GPL v3 or later.
|
||||
|
||||
== Privacy ==
|
||||
|
||||
This plugin does not collect or store any personal data beyond what is necessary for its core functionality. All data synchronization is between your WordPress site and your Hesabix account only.
|
||||
Loading…
Reference in a new issue