Skip to content

Commit 4f320d7

Browse files
committed
Updated readme and wpreadme
1 parent 0cc724c commit 4f320d7

File tree

4 files changed

+93
-33
lines changed

4 files changed

+93
-33
lines changed

README.md

+36-30
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
1-
=== Woocommerce Custom Registration ===
2-
Contributors: MUGA ICT
3-
Tags: woocommerce regsitration, woocommerce, woocommerce custom registration, woocommerce account
4-
Requires at least: 3.0.1
5-
Tested up to: 5.0.3
6-
Stable tag: {{plugin-version}}
7-
License: GPLv2 or later
8-
License URI: http://www.gnu.org/licenses/gpl-2.0.html
1+
[![Make a pull request][prs-badge]][prs]
2+
[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)
93

10-
This plugin allows you to customize the WooCommerce registration form.
11-
12-
== Description ==
4+
# Description
135

146
This plugin allows you to customize the WooCommerce registration form and collect extra user data.
157

@@ -19,36 +11,50 @@ The custom registration form will appear on WooCommerce's "my account" and "chec
1911

2012
Many custom input elements available to create your preferred WooCommerce registration form:
2113

22-
[Template vector created by freepik - www.freepik.com](https://www.freepik.com/free-photos-vectors/template)
23-
2414
- text
2515
- textarea
2616
- number
2717
- radio
2818
- select
2919
- checkbox
3020

31-
== Installation ==
21+
## Requirement
22+
23+
- WooCommerce plugin
24+
25+
## Ready to install version
26+
27+
WordPress plugins directory link: [Woocommerce Custom Registration](https://wordpress.org/plugins/woo-custom-registration/)
28+
29+
## Changelog
30+
31+
- 1.0.0 First release
32+
33+
## Getting Started
34+
35+
Clone this repository locally :
36+
37+
``` bash
38+
git clone https://github.com/ulver2812/woo-custom-registration.git
39+
```
3240

33-
1. Upload `woocommerce-custom-registration` directory to the `/wp-content/plugins/` directory
34-
2. Activate the plugin through the 'Plugins' menu in WordPress
35-
3. Make sure that you have installed and actived the WooCommerce plugin
36-
4. Go to "WooCommerce => Settings => Accounts & Privacy => Account creation " and check option
37-
"Allow customers to create an account on the 'My account' page"
41+
Install dependencies with npm :
3842

39-
== Frequently Asked Questions ==
43+
``` bash
44+
npm install
45+
```
4046

41-
= Minimum Requirements =
42-
* PHP version 5.6.0 or greater (PHP 7.1 or greater is recommended)
43-
* MySQL version 5.6 or greater
47+
## To build for production
4448

45-
== Screenshots ==
49+
- **in a terminal window** => npm run makepot
4650

47-
1. Form elements
48-
2. Element settings
49-
3. Frontend rendering
51+
and then
5052

51-
== Changelog ==
53+
- **in a terminal window** => npm run build
54+
55+
Those commands generate an updated .pot file and create a builded version in "dist" folder.
5256

53-
= 1.0.0 =
54-
* First release
57+
[license-badge]: https://img.shields.io/badge/license-Apache2-blue.svg?style=flat
58+
[license]: https://github.com/ulver2812/woo-custom-registration/LICENSE
59+
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
60+
[prs]: http://makeapullrequest.com

WPREADME.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
=== Woocommerce Custom Registration ===
2+
Contributors: MUGA ICT
3+
Tags: woocommerce regsitration, woocommerce, woocommerce custom registration, woocommerce account
4+
Requires at least: 3.0.1
5+
Tested up to: 5.0.3
6+
Stable tag: {{plugin-version}}
7+
License: GPLv2 or later
8+
License URI: http://www.gnu.org/licenses/gpl-2.0.html
9+
10+
This plugin allows you to customize the WooCommerce registration form.
11+
12+
== Description ==
13+
14+
This plugin allows you to customize the WooCommerce registration form and collect extra user data.
15+
16+
You can manage the extra user data through the WordPress User profile interface.
17+
18+
The custom registration form will appear on WooCommerce's "my account" and "checkout" page.
19+
20+
Many custom input elements available to create your preferred WooCommerce registration form:
21+
22+
- text
23+
- textarea
24+
- number
25+
- radio
26+
- select
27+
- checkbox
28+
29+
[Template vector created by freepik - www.freepik.com](https://www.freepik.com/free-photos-vectors/template)
30+
31+
== Installation ==
32+
33+
1. Upload `woocommerce-custom-registration` directory to the `/wp-content/plugins/` directory
34+
2. Activate the plugin through the 'Plugins' menu in WordPress
35+
3. Make sure that you have installed and actived the WooCommerce plugin
36+
4. Go to "WooCommerce => Settings => Accounts & Privacy => Account creation " and check option
37+
"Allow customers to create an account on the 'My account' page"
38+
39+
== Frequently Asked Questions ==
40+
41+
= Minimum Requirements =
42+
* PHP version 5.6.0 or greater (PHP 7.1 or greater is recommended)
43+
* MySQL version 5.6 or greater
44+
45+
== Screenshots ==
46+
47+
1. Form elements
48+
2. Element settings
49+
3. Frontend rendering
50+
51+
== Changelog ==
52+
53+
= 1.0.0 =
54+
* First release

build.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ fse.copySync('languages', 'dist/' + plugin_name + '/languages');
1010
fse.copySync('assets', 'dist/' + plugin_name + '/assets');
1111
fse.copySync('index.php', 'dist/' + plugin_name + '/index.php');
1212
fse.copySync('LICENSE.txt', 'dist/' + plugin_name + '/LICENSE.txt');
13-
fse.copySync('README.md', 'dist/' + plugin_name + '/README.txt');
14-
fse.copySync('README.md', 'dist/' + plugin_name + '/README.md');
13+
fse.copySync('WPREADME.md', 'dist/' + plugin_name + '/README.txt');
14+
fse.copySync('WPREADME.md', 'dist/' + plugin_name + '/README.md');
1515
fse.copySync('' + plugin_name + '.php', 'dist/' + plugin_name + '/' + plugin_name + '.php');
1616
fse.copySync('uninstall.php', 'dist/' + plugin_name + '/uninstall.php');
1717

package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)