Skip to content

Commit c30ce3d

Browse files
Update README formatting and content
1 parent 6f1b908 commit c30ce3d

File tree

1 file changed

+27
-33
lines changed

1 file changed

+27
-33
lines changed

README.md

Lines changed: 27 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414

1515
## Why Flowforge?
1616

17-
🎯 **3 Integration Patterns** - Filament Pages, Resources, or standalone Livewire
18-
**Production-Ready** - Handles 100+ cards per column with intelligent pagination
19-
🔧 **Zero Configuration** - Works with your existing models and database
20-
🎨 **Fully Customizable** - Actions, schemas, filters, and themes
17+
- **3 Integration Patterns** - Filament Pages, Resources, or standalone Livewire
18+
- **Production-Ready** - Handles 100+ cards per column with intelligent pagination
19+
- **Zero Configuration** - Works with your existing models and database
20+
- **Fully Customizable** - Actions, schemas, filters, and themes
2121

2222
---
2323

24-
## 🚀 Quick Start (90 seconds)
24+
## Quick Start
2525

2626
### 1. Install Package
2727
```bash
@@ -31,9 +31,9 @@ composer require relaticle/flowforge
3131
### 2. Include CSS Assets
3232

3333
> [!IMPORTANT]
34-
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.
34+
> If you have not set up a custom theme and are using Filament Panels, follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.
3535
36-
After setting up a custom theme add the plugin's views to your theme css file.
36+
After setting up a custom theme, add the plugin's views to your theme's CSS file.
3737

3838
```css
3939
/* In your main CSS file (e.g., resources/css/app.css) */
@@ -65,7 +65,7 @@ php artisan flowforge:make-board TaskBoard --model=Task
6565
])
6666
```
6767

68-
**🎉 Done!** Visit your Filament panel to see your Kanban board in action.
68+
**Done!** Visit your Filament panel to see your Kanban board in action.
6969

7070
### 5. Repair Positions (Optional)
7171
If you need to fix corrupted or missing position data:
@@ -75,7 +75,7 @@ php artisan flowforge:repair-positions
7575

7676
---
7777

78-
## 📋 Requirements
78+
## Requirements
7979

8080
- **PHP:** 8.3+
8181
- **Laravel:** 11+
@@ -84,10 +84,10 @@ php artisan flowforge:repair-positions
8484

8585
---
8686

87-
## 🎯 Integration Patterns
87+
## Integration Patterns
8888

8989
<details>
90-
<summary><strong>🔹 Pattern 1: Filament Page</strong></summary>
90+
<summary><strong>Pattern 1: Filament Page</strong></summary>
9191

9292
Perfect for dedicated board pages in your admin panel.
9393

@@ -120,12 +120,12 @@ class TaskBoard extends BoardPage
120120
}
121121
```
122122

123-
**Use when:** You want a standalone Kanban page in your admin panel
124-
**Benefits:** Full Filament integration, automatic registration, built-in actions
123+
**Use when:** You want a standalone Kanban page in your admin panel
124+
**Benefits:** Full Filament integration, automatic registration, built-in actions
125125
</details>
126126

127127
<details>
128-
<summary><strong>🔹 Pattern 2: Resource Integration</strong></summary>
128+
<summary><strong>Pattern 2: Resource Integration</strong></summary>
129129

130130
Integrate with your existing Filament resources. Perfect for campaign management where teams track tasks within campaigns.
131131

@@ -177,12 +177,12 @@ public static function getPages(): array
177177
}
178178
```
179179

180-
**Use when:** You want to add Kanban to existing Filament resources
181-
**Benefits:** Inherits resource permissions, policies, and global scopes
180+
**Use when:** You want to add Kanban to existing Filament resources
181+
**Benefits:** Inherits resource permissions, policies, and global scopes
182182
</details>
183183

184184
<details>
185-
<summary><strong>🔹 Pattern 3: Standalone Livewire</strong></summary>
185+
<summary><strong>Pattern 3: Standalone Livewire</strong></summary>
186186

187187
Use outside of Filament or in custom applications.
188188

@@ -236,13 +236,13 @@ class TaskBoard extends Component implements HasBoard, HasActions, HasForms
236236
</div>
237237
```
238238

239-
**Use when:** Building custom interfaces or non-Filament applications
240-
**Benefits:** Maximum flexibility, custom styling, independent routing
239+
**Use when:** Building custom interfaces or non-Filament applications
240+
**Benefits:** Maximum flexibility, custom styling, independent routing
241241
</details>
242242

243243
---
244244

245-
## 🎨 Customization
245+
## Customization
246246

247247
### Rich Card Content
248248

@@ -352,7 +352,7 @@ public function board(Board $board): Board
352352

353353
---
354354

355-
## 🏗️ Database Schema
355+
## Database Schema
356356

357357
### Required Fields
358358
```php
@@ -383,7 +383,7 @@ These collations ensure consistent fractional ranking behavior across all databa
383383

384384
---
385385

386-
## 🧪 Testing
386+
## Testing
387387

388388
<details>
389389
<summary><strong>Testing Your Boards</strong></summary>
@@ -415,7 +415,7 @@ test('can move tasks between columns', function () {
415415

416416
---
417417

418-
## 🚀 Performance Features
418+
## Performance Features
419419

420420
- **Intelligent Pagination**: Efficiently handles 100+ cards per column
421421
- **Infinite Scroll**: Smooth loading with 80% scroll threshold
@@ -425,7 +425,7 @@ test('can move tasks between columns', function () {
425425

426426
---
427427

428-
## 🎛️ API Reference
428+
## API Reference
429429

430430
<details>
431431
<summary><strong>Board Configuration</strong></summary>
@@ -457,7 +457,7 @@ Column::make('todo')
457457

458458
---
459459

460-
## 🐛 Troubleshooting
460+
## Troubleshooting
461461

462462
<details>
463463
<summary><strong>Common Issues & Solutions</strong></summary>
@@ -485,7 +485,7 @@ Column::make('todo')
485485

486486
---
487487

488-
## 🤝 Contributing
488+
## Contributing
489489

490490
Contributions are welcome! Please feel free to submit a Pull Request.
491491

@@ -495,12 +495,6 @@ Contributions are welcome! Please feel free to submit a Pull Request.
495495

496496
---
497497

498-
## 📄 License
498+
## License
499499

500500
MIT License. See [LICENSE.md](LICENSE.md) for details.
501-
502-
---
503-
504-
<div align="center">
505-
<p><strong>Built with ❤️ for the Laravel community</strong></p>
506-
</div>

0 commit comments

Comments
 (0)