diff --git a/README.md b/README.md index b14a547..b5f38ba 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,6 @@ [![PHP Version](https://img.shields.io/badge/php-%5E8.3-blue)](https://php.net) [![Laravel Version](https://img.shields.io/badge/laravel-%5E12.19-red)](https://laravel.com) [![Tests](https://github.com/Grazulex/laravel-statecraft/workflows/Tests/badge.svg)](https://github.com/Grazulex/laravel-statecraft/actions) - [![Code Quality](https://github.com/Grazulex/laravel-statecraft/workflows/Code%20Quality/badge.svg)](https://github.com/Grazulex/laravel-statecraft/actions) [![Code Style](https://img.shields.io/badge/code%20style-pint-orange)](https://github.com/laravel/pint) @@ -26,6 +25,24 @@ +## Table of Contents + +- [πŸš€ Features](#-features) +- [πŸ“¦ Installation](#-installation) +- [✨ Example: Order Workflow](#-example-order-workflow) +- [🧩 Guard Expressions](#-guard-expressions) +- [βš™οΈ Custom Guard](#-custom-guard) +- [πŸ” Custom Action](#-custom-action) +- [πŸ“œ Transition History](#-transition-history-optional) +- [βœ… Artisan Commands](#-artisan-commands) +- [πŸ§ͺ Testing](#-testing) +- [πŸ”” Events](#-events) +- [πŸ“š Documentation](#-documentation) +- [🎯 Next Steps](#-next-steps) +- [🀝 Contributing](#-contributing) +- [πŸ”’ Security](#-security) +- [πŸ“„ License](#-license) + ## πŸš€ Features - πŸ” **Declarative state machines** for Eloquent models @@ -444,14 +461,20 @@ For **comprehensive documentation**, exampl
+### πŸ“– Getting Started +- **[Documentation Overview](docs/README.md)** - Complete documentation index +- **[Configuration](docs/CONFIGURATION.md)** - Configuration options + +### 🎯 Advanced Usage - **[Console Commands](docs/CONSOLE_COMMANDS.md)** - Console commands reference - **[Guards and Actions](docs/GUARDS_AND_ACTIONS.md)** - Dynamic guards and actions - **[Guard Expressions](docs/GUARD_EXPRESSIONS.md)** - AND/OR/NOT logic for guards -- **[Configuration](docs/CONFIGURATION.md)** - Configuration options - **[Events](docs/EVENTS.md)** - Event system usage - **[Testing](docs/TESTING.md)** - Testing utilities - **[History](docs/HISTORY.md)** - State transition history -- **[Examples](examples/)** - Practical examples and use cases + +### πŸ’‘ Examples +- **[Examples Overview](examples/README.md)** - Practical examples and use cases
@@ -470,24 +493,20 @@ For **comprehensive documentation**, exampl --- -## ❀️ About +## 🀝 Contributing -
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details. -Laravel-Statecraft is part of the **Grazulex Tools** ecosystem: -`Laravel-Arc` (DTOs) β€’ `Laravel-Flowpipe` (Business Steps) β€’ `Laravel-Statecraft` (State Machines) +## πŸ”’ Security -> Designed for **clean, testable, and modular** Laravel applications. +If you discover a security vulnerability, please review our [Security Policy](SECURITY.md) before disclosing it. -
+## πŸ“„ License ---- - -## πŸ§™ Author - -
+Laravel Statecraft is open-sourced software licensed under the [MIT license](LICENSE.md). -**Jean‑Marc Strauven** / [@Grazulex](https://github.com/Grazulex) -Blog: **[Open Source My Friend](https://opensourcemyfriend.hashnode.dev)** +--- +
+ Made with ❀️ for the Laravel community
\ No newline at end of file