Skip to content

Commit 06b4a82

Browse files
authored
Merge pull request #10 from filamentphp/chore/add-usage-to-readme
Chore: add usage instructions to README
2 parents 1f7bba1 + 7ef00b6 commit 06b4a82

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@
55
[![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)
66
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
77

8+
<!--delete-->
9+
---
10+
This repo can be used to scaffold a Filament plugin. Follow these steps to get started:
11+
12+
1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
13+
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
14+
3. Make something great!
15+
---
16+
<!--/delete-->
17+
818
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
919

1020
## Installation

0 commit comments

Comments
 (0)