https://github.com/yardinternet/skeleton-package
Acorn package scaffolding
https://github.com/yardinternet/skeleton-package
acorn wordpress
Last synced: 11 months ago
JSON representation
Acorn package scaffolding
- Host: GitHub
- URL: https://github.com/yardinternet/skeleton-package
- Owner: yardinternet
- License: mit
- Created: 2024-06-10T11:55:39.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-21T11:42:52.000Z (11 months ago)
- Last Synced: 2025-07-21T13:25:22.628Z (11 months ago)
- Topics: acorn, wordpress
- Language: PHP
- Homepage:
- Size: 790 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :package_name
[](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/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. If this repo is part of the Yardinternet organisation make sure to complete the [checklist](https://github.com/yardinternet/skeleton-package/wiki/New-package-checklist)
4. Have fun creating your package.
---
## Requirements
- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0
## Installation
To install this package using Composer, follow these steps:
1. Add the following to the `repositories` section of your `composer.json`:
```json
{
"type": "vcs",
"url": "git@github.com:yardinternet/skeleton-package.git"
}
```
2. Install this package with Composer:
```sh
composer require yard/skeleton-package
```
3. Run the Acorn WP-CLI command to discover this package:
```shell
wp acorn package:discover
```
You can publish the config file with:
```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
## Usage
From a Blade template:
```blade
@include('skeleton-package::example')
```
From WP-CLI:
```shell
wp acorn example
```