Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
prappo committed Dec 9, 2024
1 parent a61d849 commit 8e2d015
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 5 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ The plugin consists of two main components: the frontend, built with React, and

To get started, you need to clone the repository and install the dependencies. Then you can rename the plugin and start development. It's that simple!

<img src="documentation/public/artworks/plugin-dev-process.svg" />

## Clone the repository
```bash
git clone https://github.com/prappo/wordpress-plugin-boilerplate.git
Expand All @@ -54,7 +56,7 @@ You can easly rename the plugin by changing data in `plugin-config.json` file.
"plugin_version":"1.0.0",
"plugin_file_name":"wordpress-plugin-boilerplate.php",
"author_name":"Prappo",
"author_uri":"https://prappo.dev",
"author_uri":"https://prappo.github.io",
"text_domain":"wordpress-plugin-boilerplate",
"domain_path":"/languages",
"main_class_name":"WordPressPluginBoilerplate",
Expand Down
2 changes: 1 addition & 1 deletion documentation/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can easly rename the plugin by changing data in `plugin-config.json` file.
"plugin_version": "1.0.0",
"plugin_file_name": "wordpress-plugin-boilerplate.php",
"author_name": "Prappo",
"author_uri": "https://prappo.dev",
"author_uri": "https://prappo.github.io",
"text_domain": "wordpress-plugin-boilerplate",
"domain_path": "/languages",
"main_class_name": "WordPressPluginBoilerplate",
Expand Down
3 changes: 3 additions & 0 deletions documentation/public/artworks/plugin-dev-process.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion gruntfile.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ grunt.initConfig({
recursive: false
},
change_author_uri:{
pattern: "https://prappo.dev",
pattern: "https://prappo.github.io",
replacement: config.author_uri,
path: config.plugin_file_name,
recursive: false
Expand Down
2 changes: 1 addition & 1 deletion plugin-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"plugin_version":"1.0.0",
"plugin_file_name":"wordpress-plugin-boilerplate.php",
"author_name":"Prappo",
"author_uri":"https://prappo.dev",
"author_uri":"https://prappo.github.io",
"text_domain":"wordpress-plugin-boilerplate",
"domain_path":"/languages",
"main_class_name":"WordPressPluginBoilerplate",
Expand Down
2 changes: 1 addition & 1 deletion wordpress-plugin-boilerplate.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Plugin Name: WordPress Plugin Boilerplate
* Description: A boilerplate for WordPress plugins.
* Author: Prappo
* Author URI: https://prappo.dev
* Author URI: https://prappo.github.io
* License: GPLv2
* Version: 1.0.0
* Text Domain: wordpress-plugin-boilerplate
Expand Down

0 comments on commit 8e2d015

Please sign in to comment.