From 696db21ed7ddee332e7c64f6d453aad29c8fd32c Mon Sep 17 00:00:00 2001 From: "Ipstenu (Mika Epstein)" Date: Mon, 27 Nov 2017 14:07:36 -0800 Subject: [PATCH] Clarifying directions --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 91c837a..312786b 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,13 @@ The WordPress Plugin Boilerplate includes the following files: ## Installation -The Boilerplate can be installed directly into your plugins folder "as-is". You will want to rename it and the classes inside of it to fit your needs. +The Boilerplate can be installed directly into your plugins folder "as-is". You will want to rename it and the classes inside of it to fit your needs. For example, if your plugin is named 'example-me' then: -Note that this will activate the source code of the Boilerplate, but because the Boilerplate has no real functionality there will be no menu items, meta boxes, or custom post types added. +* rename files from `plugin_name` to `example_me` +* change `plugin_name` to `example_me` +* change `PLUGIN_NAME_` to `EXAMPLE_ME_` + +It's safe to activate the plugin at this point. Because the Boilerplate has no real functionality there will be no menu items, meta boxes, or custom post types added until you write the code. ## WordPress.org Preparation