Skip to content

Commit b355aa7

Browse files
authored
Update readme.md
1 parent 731a1fc commit b355aa7

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

readme.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
# Haste Toolkit
22

3-
Haste Toolkit is plugin development starter, with some useful resources like composer autoload, PHPCS, LaravelMix and a small project structure to help you start your plugin development without caring too much about those simple things.
3+
Haste Toolkit is plugin development starter, with some useful resources like composer autoload, LaravelMix, PHPCS and a small project structure to help you start your plugin development without caring too much about those simple things.
44

5-
- Requires at least: 4.0.0
6-
- Tested up to: 5.2.3
7-
- Stable tag: 0.0.1
8-
- License: GPLv2 or later
9-
- License URI: http://www.gnu.org/licenses/gpl-2.0.html
5+
## Getting Started
6+
7+
You will need to download and rename Haste Toolkit to reflect the name and slugs of your custom plugin to be developed, after that, you are ready to install and activate it, and start coding your fucntionalities!
8+
9+
- Download the lastest version of Haste Toolkit
10+
- Extract it to your `/plugins` folder
11+
- Renaming
12+
- - Rename it to the desired plugin slug. (Ex. `my-plugin-name`)
13+
- - Rename the main plugin file to reflect the folder name.
14+
- - Rename namespaces from `HasteToolkit`to `MyPluginNamespace`
15+
- - Rename comments, prefixes and other stuff, searching for `HasteToolkit`, `haste-toolkit`, `haste_toolkit`, `haste`.
16+
- Activate the plugin
17+
18+
The plugin will do nothing, so you're able to start developing your functionalities in the way you want. The main plugin file is responsible to register the plugin, load the translation, load the composer PSR-4 autoload, and require the `functions.php` file.
19+
20+
### The functions.php file
21+
The `functions.php` in the root of the plugin can be used almost like a `functions.php` of a theme. It was built to make easy to anyone familiar with WordPress theme functions to get started. Just put your hooks and callbacks there, and it should work!

0 commit comments

Comments
 (0)