Skip to content

Commit

Permalink
build(intial): initial build
Browse files Browse the repository at this point in the history
  • Loading branch information
bmarshall511 committed Dec 9, 2023
1 parent 9ec2c6b commit 84eb8bb
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
33 changes: 33 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -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 ==

0 comments on commit 84eb8bb

Please sign in to comment.