diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..7b6175c --- /dev/null +++ b/readme.md @@ -0,0 +1,82 @@ +# Woo Viet - WooCommerce for Vietnam + +| Name | Value | +|:---|:---| +| Contributors | htdat | +|Tags| WooCommerce Vietnam, vietnam, vietnamese, vietnam provinces, paypal for vietnam dong, vnd, vietnam dong, vietnam currency, vietnam customization | +| Requires at least | 4.3 | +| Tested up to | 4.7 | +| Stable tag | 1.2 | +| License | GPLv2 or later | +| License URI | https://www.gnu.org/licenses/gpl-2.0.html | + +Add features to WooCommerce stores having anything related to Vietnam: currency, shipping address, PayPal and more. + +## Description + +**"Woo Viet - WooCommerce for Vietnam" brings the features that help to run WooCommerce stores and customize them for Vietnam much easier.** + +Xem phiên bản tiếng Việt tại đây https://vi.wordpress.org/plugins/woo-viet/ + +## FEATURES + +* Change the VND currency symbol `đ` to anything, e.g: `VND`, `VNĐ`, `đồng`, etc. +* Add provinces for Vietnam when visitors select Vietnam as a country of the shipping (billing) address. This is not available in WooCommerce by default. +* Convert `000` of prices to `K` (or anything). E.g: `50000` (VND) will be `50K` (VND), or `50 thousand` (VND). +* Support `VND` for [the PayPal Standard gateway](https://docs.woocommerce.com/document/paypal-standard/). Convert `VND` prices to any PayPal supported currency before sending visitors to the PayPal pages. + +## ROAD MAP + +In the future, this plugin will add more and more features for the Vietnam market: + +* Integrate all districts to Vietnam provinces. +* Integrate at least one solution for collecting money by phone cards. +* Integrate the Vietnam payment gateways like 1Pay, OnePay, BaoKim, Ngan Luong, etc. +* Integrate the Vietnam shipping solutions like ShipChung, Giaohangnhanh, ViettelPost, etc. + +## WHERE CAN I CONTRIBUTE MY CODE OR IDEA? + +* You can report bugs or contribute code on [this GitHub repo](https://github.com/htdat/woo-viet). +* Please also do let us know if the "bug" is just a grammar/spelling error in both English and Vietnamese. We try to make our products as perfect as possible. + +## INSTALLATION + +Follow these steps to install and use the plugin: + +1. Upload the plugin files to the `/wp-content/plugins/woo-viet` directory, or install the plugin through the WordPress plugins screen directly. +1. Activate the plugin through the `Plugins` screen in WordPress. +1. Go to the `WooCommerce -> Woo Viet` screen and configure the plugin. + +## Installation + +Follow these steps to install and use the plugin: + +1. Upload the plugin files to the `/wp-content/plugins/woo-viet` directory, or install the plugin through the WordPress plugins screen directly. +1. Activate the plugin through the 'Plugins' screen in WordPress. +1. Go to the `WooCommerce -> Woo Viet` screen and configure the plugin. + + +## Frequently Asked Questions + +### WHERE CAN I CONTRIBUTE MY CODE OR IDEA? + +* You can report bugs or contribute code on [this GitHub repo](https://github.com/htdat/woo-viet). +* Please also do let us know if the "bug" is just a grammar/spelling error in both English and Vietnamese. We try to make our products as perfect as possible. + +## Screenshots + +1. The settings page under WooCommerce -> Woo Viet. +2. Prices are changed to "K", and the symbol is now "VND". +3. List provinces when selecting Vietnam. +4. Let clients know about the currency conversion before switching to the PayPal pages. + +## Changelog + +### 1.1 +* Replace all “WooCommerce for Vietnam” to “Woo Viet” +* Replace all “woocomerce-for-vietnam” to “woo-viet” +* Re-upload to WordPress.org + +### 1.0 +* First release. +* Upload to WordPress.org