From 84eb8bb1e4bdc06b0347e4a858720f322027611b Mon Sep 17 00:00:00 2001 From: Ben Marshall Date: Sat, 9 Dec 2023 12:51:07 -0600 Subject: [PATCH] build(intial): initial build --- README.md | 4 +++- hookdoc-conf.json => docs-conf.json | 0 package.json | 2 +- readme.txt | 33 +++++++++++++++++++++++++++++ 4 files changed, 37 insertions(+), 2 deletions(-) rename hookdoc-conf.json => docs-conf.json (100%) create mode 100644 readme.txt diff --git a/README.md b/README.md index 6e23b6d..ea3a6e1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # WP Plugin Scaffold -> A plugin WordPress scaffold to help you get started quickly. +> Streamline WordPress plugin creation with our scaffold, offering WordPress Coding Standards, PHPDoc, 10up Toolkit, and a ready-to-use admin page. [![Support Level](https://img.shields.io/badge/support-active-green.svg)](#support-level) [![MIT License](https://img.shields.io/github/license/Highfivery/wp-plugin-scaffold.svg)](https://github.com/Highfivery/wp-plugin-scaffold/blob/trunk/LICENSE.md) ## Overview +Kickstart your WordPress plugin development with the WordPress Plugin Scaffold. Adhering to WordPress Coding Standards and equipped with PHPDoc for seamless documentation, our scaffold streamlines your workflow. It includes 10up Toolkit for efficient linting, compiling, and file optimization, plus a ready-to-go block build framework and an admin options page template. Ideal for developers seeking a robust starting point. + ## Support Level **Active:** Highfivery is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome. diff --git a/hookdoc-conf.json b/docs-conf.json similarity index 100% rename from hookdoc-conf.json rename to docs-conf.json diff --git a/package.json b/package.json index 639a001..fb45593 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "start": "npm run watch", "watch": "10up-toolkit watch --port=5000", "build": "10up-toolkit build", - "build:docs": "rm -rf docs/ && jsdoc -c hookdoc-conf.json", + "build:docs": "rm -rf docs/ && jsdoc -c docs-conf.json", "format-js": "10up-toolkit format-js", "lint-js": "10up-toolkit lint-js", "lint-style": "10up-toolkit lint-style", diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..51a6551 --- /dev/null +++ b/readme.txt @@ -0,0 +1,33 @@ +=== WordPress Plugin Scaffold === +Contributors: bmarshall511 +Tags: +Donate link: https://highfivery.com +Requires at least: 5.2 +Tested up to: 6.2.2 +Requires PHP: 7.4 +Stable tag: 0.1.0 +License: GPLv2 or later +License URI: http://www.gnu.org/licenses/gpl-2.0.html + +Streamline WordPress plugin creation with our scaffold, offering WordPress +Coding Standards, PHPDoc, 10up Toolkit, and a ready-to-use admin page. + +== Description == + +Kickstart your WordPress plugin development with the WordPress Plugin Scaffold. +Adhering to WordPress Coding Standards and equipped with PHPDoc for seamless +documentation, our scaffold streamlines your workflow. It includes 10up Toolkit +for efficient linting, compiling, and file optimization, plus a ready-to-go +block build framework and an admin options page template. Ideal for developers +seeking a robust starting point. + +== Installation == + +1. Upload the entire plugin folder to the */wp-content/plugins/* directory. +2. Activate the plugin through the Plugins screen (*Plugins > Installed Plugins*). + +== Frequently Asked Questions == + +== Screenshots == + +== Changelog ==