Skip to content

Commit ff77184

Browse files
committed
feat(docs): enhance README with new features and usage examples for Standalone Livewire and Filament integration
1 parent 286dcc9 commit ff77184

File tree

1 file changed

+43
-10
lines changed

1 file changed

+43
-10
lines changed

README.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,74 @@
22

33
Transform any Laravel model into a production-ready drag-and-drop Kanban board.
44

5+
**Works with Filament admin panels and standalone Livewire applications.**
6+
57
[![Latest Version](https://img.shields.io/packagist/v/relaticle/flowforge.svg?style=for-the-badge)](https://packagist.org/packages/relaticle/flowforge)
68
[![Total Downloads](https://img.shields.io/packagist/dt/relaticle/flowforge.svg?style=for-the-badge)](https://packagist.org/packages/relaticle/flowforge)
79
[![PHP 8.3+](https://img.shields.io/badge/php-8.3%2B-blue.svg?style=for-the-badge)](https://php.net)
8-
[![Filament 4](https://img.shields.io/badge/filament-4.x-purple.svg?style=for-the-badge)](https://filamentphp.com)
10+
[![Laravel 11+](https://img.shields.io/badge/laravel-11%2B-red.svg?style=for-the-badge)](https://laravel.com)
911
[![Tests](https://img.shields.io/github/actions/workflow/status/relaticle/flowforge/run-tests.yml?branch=2.x&style=for-the-badge&label=tests)](https://github.com/relaticle/flowforge/actions)
1012

1113
<div align="center">
1214
<img src="art/preview.png" alt="Flowforge Kanban Board" width="800">
1315
</div>
1416

15-
## Why Flowforge?
17+
## Features
1618

17-
- **3 Integration Patterns** - Filament Pages, Resources, or standalone Livewire
18-
- **Production-Ready** - Handles 100+ cards per column with intelligent pagination
19-
- **Quick Setup** - Get running in 90 seconds with minimal configuration
20-
- **Fully Customizable** - Actions, schemas, filters, and themes
19+
- **3 Integration Patterns** - Works with Filament Pages, Resources, or standalone Livewire components
20+
- **Enterprise-Scale Performance** - Cursor-based pagination handles unlimited cards with intelligent loading
21+
- **Rich Card Schemas** - Filament Schema builder creates complex card layouts with forms and components
22+
- **Smart Position Management** - Advanced ranking algorithm with conflict resolution and repair commands
23+
- **Optimistic UI Experience** - Instant visual feedback with loading states and smooth interactions
24+
- **Native Filament Integration** - Deep table system integration for filters, search, and actions
2125

2226

2327
## Requirements
2428

2529
- **PHP:** 8.3+
2630
- **Laravel:** 11+
27-
- **Filament:** 4.x
31+
- **Livewire:** 3.x+
32+
- **Filament:** 4.x+
2833
- **Database:** MySQL, PostgreSQL, SQLite, SQL Server, MariaDB
2934

3035

31-
## Quick Start
36+
## Installation
3237

3338
```bash
3439
composer require relaticle/flowforge
3540
```
3641

37-
Add CSS assets to your theme, create a position column, generate your board, and register it in your panel.
42+
## Usage
43+
44+
**Standalone Livewire** (any Laravel application):
45+
```php
46+
use Relaticle\Flowforge\Concerns\InteractsWithBoard;
47+
48+
class TaskBoard extends Component implements HasBoard
49+
{
50+
use InteractsWithBoard;
51+
52+
public function board(Board $board): Board
53+
{
54+
return $board
55+
->query(Task::query())
56+
->columnIdentifier('status')
57+
->positionIdentifier('position')
58+
->columns([
59+
Column::make('todo')->label('To Do')->color('gray'),
60+
Column::make('in_progress')->label('In Progress')->color('blue'),
61+
Column::make('completed')->label('Completed')->color('green'),
62+
]);
63+
}
64+
}
65+
```
66+
67+
**Filament Admin Panel**:
68+
```bash
69+
php artisan flowforge:make-board TaskBoard --model=Task
70+
```
3871

39-
**[View Complete Documentation](https://relaticle.github.io/flowforge/)**
72+
**[View Complete Documentation](https://relaticle.github.io/flowforge/)**
4073

4174

4275
## Contributing

0 commit comments

Comments
 (0)