diff --git a/README.md b/README.md index ce46d12..4919462 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # WordPress Plugin Boilerplate -The WordPress Plugin Boilerplate serves as a foundation off of which to build your WordPress plugins. +The WordPress Plugin Boilerplate serves as a foundation and aims to provide a clear and consistent guide for building your WordPress plugins. ## Features @@ -9,9 +9,13 @@ The WordPress Plugin Boilerplate serves as a foundation off of which to build yo * Liberal use of `TODO` to guide you through what you need to change * Uses a strict file organization scheme to make sure the assets are easily maintainable -## Usage +## Contents + +The WordPress Plugin Boilerplate includes the following files: + +* This `README` +* A subdirectory called `plugin-boilerplate` -The WordPress Plugin Boilerplate is ready to activate as-is (though it includes no real functionality). 1. Copy the `plugin-boilerplate` directory into your `wp-content/plugins` directory 2. Navigate to the "Plugins" dashboard page @@ -20,6 +24,12 @@ The WordPress Plugin Boilerplate is ready to activate as-is (though it includes This will activate the WordPress Plugin Boilerplate. Because the Boilerplate has no real functionality, nothing will be added to WordPress; however, this demonstrates exactly how your plugin should behave as you're working with it. +If you opt to uncomment Line 77 which contains the following line: + + `add_action( 'admin_menu', array( $this, 'plugin_admin_menu' ) );` + +Then a new menu item will be added to the *Plugins* menu. + ## License The WordPress Plugin Boilerplate is licensed under the GPL v2 or later. @@ -39,12 +49,28 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA ## Changelog +### 2.0 (7 May 2012) + +* Disabling the admin menu by default +* Initializing the attributes +* Combining the `admin_open` and `admin_close` into a single `admin` view +* Bringing some of the code up to the WordPress coding standards +* Added access modifiers for functions +* Implemented the single pattern +* **japh**. Merged upstream changes, maintained separation of uninstall functionality +* **mikkelbreum**. Restricted scripts and styles to load only on plugin settings page if it is enabled. +* **mikkelbreum**. Added the option for a plugin settings page +* **mikkelbreum**. Removed the need to customize the URL for `wp_enqueue_style` and `wp_enqueue_scripts` +* **mikkelbreum**. Corrected action book for `register_admin_styles` +* **tbwiii**. Listed jQuery as a dependency for both JavaScript sources +* **japh**. Added an `uninstall.php` placeholder +* **leewillis77**. Improved the way language files are loaded +* **wesbos**. Updated the year to 2013 + ### 1.0 (29 November 2012) * Official Release ## Author Information -The WordPress Plugin Boilerplate was originally started and is maintained by [Tom McFarlin](http://twitter.com/tommcfarlin/). - -The project is open-source and receives contributions from awesome WordPress Developers throughout the world. +The WordPress Plugin Boilerplate was originally started and is maintained by [Tom McFarlin](http://twitter.com/tommcfarlin/), but is constantly under development thanks to the contributions from the many WordPress developers throughout the world.