Skip to content

yardinternet/skeleton-package

Repository files navigation

:package_name

Code Style PHPStan Tests Code Coverage Badge Lines of Code Badge


This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the Acorn Package Development documentation.

Follow these steps to get started:

  1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
  2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
  3. Have fun creating your package.

Requirements

Installation

To install this package using Composer, follow these steps:

  1. Add the following to the repositories section of your composer.json:

    {
      "type": "vcs",
      "url": "[email protected]:yardinternet/skeleton-package.git"
    }
  2. Install this package with Composer:

    composer require yard/skeleton-package
  3. Run the Acorn WP-CLI command to discover this package:

    wp acorn package:discover

You can publish the config file with:

wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"

Usage

From a Blade template:

@include('skeleton-package::example')

From WP-CLI:

wp acorn example

Releases

No releases published

Packages

No packages published