Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 2.47 KB

README.md

File metadata and controls

73 lines (48 loc) · 2.47 KB
Raw

:package_description

PHP Version Require Latest Stable Version phpunit psalm Codecov Total Downloads

This repo can be used to scaffold a Spiral Framework 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 a script that will replace all placeholders throughout all the files.

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

Requirements

Make sure that your server is configured with following PHP version and extensions:

  • PHP 8.1+
  • Spiral framework 3.0+

Installation

You can install the package via composer:

composer require :vendor_slug/:package_slug

After package install you need to register bootloader from the package.

protected const LOAD = [
    // ...
    \VendorName\Skeleton\Bootloader\SkeletonBootloader::class,
];

Note: if you are using spiral-packages/discoverer, you don't need to register bootloader by yourself.

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

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

Credits

License

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