Skip to content

Commit d60bcc5

Browse files
committed
Updated to match README.md
1 parent 2da64ea commit d60bcc5

1 file changed

Lines changed: 33 additions & 8 deletions

File tree

readme.txt

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,33 @@ This plugin is intended to be used as a boilerplate for creating quick WordPress
1212
== Description ==
1313
This is a boilerplate WordPress plugin featuring namespace autoloading and integration with [Carbon Fields](https://github.com/htmlburger/carbon-fields).
1414

15-
It is intended to be used as a starting point for creating quick WordPress plugins.
15+
It is intended to be used as a starting point for quickly creating WordPress plugins.
16+
17+
= Requirements =
18+
19+
* WordPress 4.0 or higher
20+
* PHP 5.4 or higher
1621

1722
== Installation ==
1823

1924
= Zip File =
2025

2126
1. Download the ZIP distribution from Github.
2227
2. Extract to your plugin folder.
23-
3. Activate the plugin in WordPress admin.
24-
4. Go to Settings > WordPress Base Plugin to see a sample settings page.
28+
3. Configure & run Composer.
29+
30+
= Clone Repository =
31+
32+
1. At command prompt, change to your `wp-content/plugins` directory.
33+
2. Close the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
34+
3. Configure & run Composer.
2535

26-
= Git Clone =
36+
= Composer =
2737

28-
1. Clone the plugin from the GitHub repo to your WordPress plugins folder.
29-
3. Activate the plugin in WordPress admin.
30-
4. Go to Settings > WordPress Base Plugin to see a sample settings page.
38+
Once you have the source files:
39+
40+
1. Modify `composer.json` to suit your needs
41+
2. Run `composer install` to install dependencies and autoload namespace
3142

3243
== Frequently Asked Questions ==
3344
= Q. What is Composer? =
@@ -37,5 +48,19 @@ A. Composer is an application-level package manager for the PHP programming lang
3748
1. Settings Page
3849

3950
== Changelog ==
51+
= 0.2.0 =
52+
* Added Object Cache class
53+
* Added example of loading Font Awesome if enabled in plugin settings
54+
* Removed `./vendor` from repo
55+
* Renamed Helpers Class to Utils
56+
* Tested PHP 5.4 - 7.1 compatibility
57+
* Added minimum PHP version check
58+
* Added screenshot
59+
* Moved `/src` to `/app`
60+
61+
= 0.1.1 =
62+
* Refactored code
63+
* Added `is_production()` and `is_ajax()` methods
64+
4065
= 0.1.0 =
41-
* Initial release
66+
* Initial commit

0 commit comments

Comments
 (0)