You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-7Lines changed: 33 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ It may also be used as the means of [separating custom code](http://www.billeric
14
14
15
15
* Namespaces & dependency autoloading
16
16
* Version checking (PHP, Carbon Fields)
17
-
*[Gulp](https://gulpjs.com/) for JavaScript/SASS processing & minification (see [Gulp](https://github.com/dmhendricks/wordpress-base-plugin/wiki#gulp) notes)
17
+
*Powered by [Composer](https://getcomposer.org/), [Gulp](https://gulpjs.com/) and [Bower](https://bower.io/)
* Automatic translation file (`.pot`) creation. See [Translation](https://github.com/dmhendricks/wordpress-base-plugin/wiki#translation).
20
20
* Shortcodes, widgets and custom post type (via [PostTypes](https://github.com/jjgrainger/PostTypes/)) examples
@@ -36,8 +36,29 @@ It may also be used as the means of [separating custom code](http://www.billeric
36
36
37
37
### Composer
38
38
39
-
1. Modify `composer.json` to suit your needs
40
-
1. Run `composer install` to install dependencies and autoload namespace
39
+
1. Modify `composer.json` to suit your needs.
40
+
1. Run `composer install` to install dependencies and autoload namespace.
41
+
42
+
### NPM
43
+
44
+
1. Modify `package.json` to suit your needs. Specifically, change the `config` section.
45
+
1. Run `npm install` to install dependencies.
46
+
47
+
### Bower
48
+
49
+
This step is only necessary for the "Clear Cache" Ajax example. Whether or not you choose to use Bower is up to you. Alternatively, you may put JavaScript dependencies in `src/vendor` and enqueue `assets/js/wordpress-base-plugin-vendor.js` as needed.
50
+
51
+
```
52
+
$ bower install
53
+
```
54
+
55
+
### Gulp
56
+
57
+
Using Gulp is also optional (but recommended). If you wish to try the base plugin with all of its examples, you will need to run Gulp to process the JavaScripts:
58
+
59
+
```
60
+
$ gulp
61
+
```
41
62
42
63
### Next Steps
43
64
@@ -49,13 +70,17 @@ This plugin loads many of its defaults & settings from `plugin.json`. See [Confi
49
70
50
71
## Planned Features & TODO
51
72
73
+
#### Before 3.0 Pre-Release
74
+
52
75
* Update documentation to reflect recent changes
53
-
* Add encrypt/decrypt example (`password` field with encrypted `hidden` field)
76
+
* Add gulp task to package plugin as ZIP file; move NPM scripts to gulp tasks
77
+
* Use [TGMPA](http://tgmpluginactivation.com/) for Carbon Fields dependency checking
78
+
* Simplify/clean-up version checking in general
79
+
80
+
#### Future Releases
81
+
54
82
* Add Customizer example
55
83
* Add dynamically-created CSS/JS files based on settings
56
-
* Add gulp task to package plugin as zip file
57
-
* Use [Bower](https://bower.io/) to manage vendor scripts and move `./src/js/vendor` to `./src/components`
58
-
* Use [TGMPA](http://tgmpluginactivation.com/) for Carbon Fields dependency checking
59
84
60
85
## Change Log
61
86
@@ -65,6 +90,7 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
65
90
66
91
* Bumped minimum PHP version check to 5.6
67
92
* Added [Gulp](https://gulpjs.com/) for task automation (SASS, JS processing)
93
+
* Added [Bower](https://bower.io/) to (optionally) load third-party scripts
68
94
* Drastically refactored configuration management
69
95
* Split out settings pages, shortcodes, CPT & widgets into separate files/classes (thanks [obstschale](https://github.com/obstschale/wordpress-base-plugin))
70
96
* Added `wp-pot-cli` to `package.json` to create `.pot` translation file
0 commit comments