diff --git a/README.md b/README.md index 3ecd41e..6bb3391 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ [![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain) [![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug) + +--- +This repo can be used to scaffold a Filament plugin. 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. Make something great! +--- + + This is where your description should go. Limit it to a paragraph or two. Consider adding a small example. ## Installation