Skip to content

Commit

Permalink
Add note to README regarding the plugin assets (#149)
Browse files Browse the repository at this point in the history
* Update README.md

* Update docs README

* reorder docs

---------

Co-authored-by: ZedoX <[email protected]>
  • Loading branch information
pboivin and Z3d0X authored Apr 7, 2024
1 parent f30a908 commit 2969386
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@

***What is Filament Fabricator?*** Filament Fabricator is simply said a block-based page builder skeleton. Filament Fabricator takes care of the PageResource & frontend routing, so you can focus on what really matters: your [Layouts](https://filamentphp.com/plugins/z3d0x-fabricator#layouts) & [Page Blocks](https://filamentphp.com/plugins/z3d0x-fabricator#page-blocks).

## Compatibility
| Fabricator | Filament | PHP |
|------|----------|--------|
| [1.x](https://github.com/z3d0x/filament-fabricator/tree/1.x) | ^2.0 | ^8.0 |
| [2.x](https://github.com/z3d0x/filament-fabricator/tree/2.x) | ^3.0 | ^8.1 |

## Installation

You can install the package via composer:
Expand Down Expand Up @@ -40,11 +46,11 @@ public function panel(Panel $panel): Panel
}
```

## Compatibility
| Fabricator | Filament | PHP |
|------|----------|--------|
| [1.x](https://github.com/z3d0x/filament-fabricator/tree/1.x) | ^2.0 | ^8.0 |
| [2.x](https://github.com/z3d0x/filament-fabricator/tree/2.x) | ^3.0 | ^8.1 |
Then, publish the registered plugin assets:

```
php artisan filament:assets
```

## Documentation

Expand Down
7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ public function panel(Panel $panel): Panel
}
```

Then, publish the registered plugin assets:

```
php artisan filament:assets
```


To get started create a [Layout](#layouts) and then [Page Blocks](#page-blocks)

## Layouts
Expand Down

0 comments on commit 2969386

Please sign in to comment.