:package_name

---

This repo can be used to scaffold a Laravel package. Follow these steps to get started:

1. Press the "Use 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 the script that will replace all placeholders throughout all the files.
3. Remove this block of text.

---

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require :vendor_slug/:package_slug

You can publish and run the migrations with:

php artisan vendor:publish --tag=":package_slug-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag=":package_slug-config"

You can view the default configuration here: https://github.com/:vendor_slug/:package_slug/blob/main/config/:package_slug.php

Usage

$skeleton = new VendorName\Skeleton;
echo $skeleton->echoPhrase('Hello, VendorName!');

Scripts

Setup

For convenience, you can run the setup bin script for easy installation for local development.

./bin/setup.sh

Formatting

Although formatting is done automatically via workflow, you can format php code locally before committing with a composer script:

composer format

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

Please review my security policy on how to report security vulnerabilities.

Credits

• :author_name
• All Contributors

License

The MIT License (MIT). Please see License File for more information.