Skip to content

Commit

Permalink
Explained how the sync works & why this plugin is needed
Browse files Browse the repository at this point in the history
  • Loading branch information
wireblue authored May 9, 2024
1 parent fcc6828 commit 5fbfcd3
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,16 @@
This plugin provides a settings screen within the WP Admin area and also enables data to be synced to/from the ERP Sync Tool.


## How it works
The [ERP Sync Tool is a Laravel application](https://github.com/pvtl/erp-sync-tool) that synchronises data between two systems. Typically one system is ERP software (like Pacsoft or Unleashed), while the other side is a retail/wholesale store built on WooCommerce.

At regular intervals, the (Laravel) Sync Tool will connect to the ERP software and fetch the latest changes to products, customers, orders etc. It also fetches the same data from WooCommerce. Then it compares what changes have occurred, and selectively synchronises those changes back to their respective systems.

This plugin provides the necessary customisations to WordPress/WooCommerce to enable the sync to work.


## Git Tags

Git will automatically tag a commit whenever a change to the version number is detected inside `erp-sync-tool.php`.

This behaviour is handled by `.github/workflows/version-update.yml`.
This behaviour is handled by `.github/workflows/version-update.yml`.

0 comments on commit 5fbfcd3

Please sign in to comment.