From 92ae98a9e087b461bb3947362b7ca32c366116ed Mon Sep 17 00:00:00 2001 From: Ryan Scherler Date: Sun, 14 Feb 2021 13:40:22 -0800 Subject: [PATCH] cleanup readme --- README.md | 66 +------------------------------------------------------ 1 file changed, 1 insertion(+), 65 deletions(-) diff --git a/README.md b/README.md index d736d045e7..23e0adbc0e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Filament -A lightweight admin package to jumpstart your Laravel app. +A lightweight admin panel for the TALL stack. ## Installation @@ -13,72 +13,8 @@ composer require filament/filament dev-master php artisan migrate ``` -### Create a Resource - -To define a Resource, create a new resource file in `app/Filament/Resources` like the following `Page.php`. - -```php -enabled = Auth::user()->can('Access My Pages'); - } - - public function actions() - { - return [ - 'index' => Index::class, - ]; - } -} -``` - -> Below is an example of a corresponding Livewire component defined in the resource above: - -```php - Page::paginate(12), - ])->layout('filament::layouts.app', ['title' => 'Pages']); - } -} -``` - ### Create a user ```bash php artisan make:filament-user ``` - ---- - -## Roadmap - -- [ ] Dashboard widgets - - Bookmarks Feature with associated widget -- [ ] Resource stubs and associated Artisan commands (e.g. `artisan filament:resource Page --options`) -- [ ] DOCUMENTATION FOR ALL THE THINGS.