Add comprehensive documentation for Laravel Running Number

- Introduced new section on Integration Patterns with examples for event-driven integration, API integration, queue integration, caching strategies, and microservices integration.
- Expanded the Advanced Topics section with detailed guides on custom presenters and generators.
- Created a Testing guide with examples using Pest and PHPUnit, including best practices for testing running number generation.
- Developed a Contributing guide outlining ways to contribute, reporting bugs, and submitting pull requests.
- Established a Development Setup guide for setting up a local environment and running tests.
- Added an Upgrade Guide detailing migration steps between major versions, including breaking changes and new features.
- Enhanced the main README with structured navigation and key features of the package.

Author: nasrulhazim

.gitignore

@@ -5,7 +5,6 @@
 build
 composer.lock
 coverage
-docs
 phpunit.xml
 phpstan.neon
 testbench.yaml

docs/01-getting-started/01-installation.md

@@ -0,0 +1,103 @@
+# Installation
+
+This guide will walk you through installing and setting up Laravel Running Number in your Laravel application.
+
+## Requirements
+
+Before installing, ensure your environment meets these requirements:
+
+- **PHP**: 8.1, 8.2, 8.3, or 8.4
+- **Laravel**: 9.x, 10.x, 11.x, or 12.x
+- **Database**: MySQL, PostgreSQL, SQLite, or SQL Server
+
+## Step 1: Install via Composer
+
+Install the package using Composer:
+
+```bash
+composer require cleaniquecoders/laravel-running-number
+```
+
+## Step 2: Publish Migrations
+
+Publish the migration files to your application:
+
+```bash
+php artisan vendor:publish --tag="running-number-migrations"
+```
+
+This will create two migration files in your `database/migrations` directory:
+
+- `create_running_number_table.php` - Creates the main running numbers table
+- `add_uuid_to_running_numbers_table.php` - Adds UUID support (v2.x+)
+
+## Step 3: Run Migrations
+
+Execute the migrations to create the required database tables:
+
+```bash
+php artisan migrate
+```
+
+This creates a `running_numbers` table with the following structure:
+
+| Column | Type | Description |
+|--------|------|-------------|
+| `id` | bigint | Primary key |
+| `uuid` | uuid | Unique identifier (v2.x+) |
+| `type` | string | Running number type (e.g., INVOICE, PROFILE) |
+| `number` | integer | Current sequence number |
+| `created_at` | timestamp | Creation timestamp |
+| `updated_at` | timestamp | Last update timestamp |
+
+## Step 4: Publish Configuration (Optional)
+
+If you want to customize the package configuration, publish the config file:
+
+```bash
+php artisan vendor:publish --tag="running-number-config"
+```
+
+This creates a `config/running-number.php` file that you can customize. See the [Configuration Guide](../02-configuration/01-overview.md) for details.
+
+## Verification
+
+Verify the installation was successful by running a quick test in `php artisan tinker`:
+
+```php
+php artisan tinker
+
+>>> use CleaniqueCoders\RunningNumber\Enums\Organization;
+>>> running_number()->type(Organization::PROFILE->value)->generate();
+=> "PROFILE001"
+```
+
+If you see the generated running number, you're all set! 🎉
+
+## Upgrading from Previous Versions
+
+If you're upgrading from a previous version, please refer to the [Upgrade Guide](../06-upgrade-guide.md) for detailed migration instructions:
+
+- **[Upgrading to v3.0.0](../06-upgrade-guide.md#upgrading-to-v3x-from-v2x)** - Documentation & developer experience enhancements
+- **[Upgrading to v2.x](../06-upgrade-guide.md#upgrading-to-v2x-from-v1x)** - Native PHP enums, UUID support
+
+## Troubleshooting
+
+### Migration Already Exists
+
+If you see an error that the migration already exists, you may have previously installed an older version. Check your `database/migrations` directory and remove any old running number migrations before publishing the new ones.
+
+### Table Already Exists
+
+If the `running_numbers` table already exists from a previous installation, you can skip the migration or modify the migration file to only add the UUID column if upgrading from v1.x.
+
+### Class Not Found
+
+If you encounter "Class not found" errors, make sure to:
+
+1. Clear your application cache: `php artisan config:clear && php artisan cache:clear`
+2. Regenerate the autoload files: `composer dump-autoload`
+
+## Next Steps
+
+Now that you have the package installed, check out the [Quick Start Guide](02-quick-start.md) to learn how to use it!

docs/01-getting-started/02-quick-start.md

@@ -0,0 +1,199 @@
+# Quick Start
+
+Get up and running with Laravel Running Number in just a few minutes! This guide covers the most common use cases.
+
+## Basic Usage
+
+### Using the Helper Function
+
+The simplest way to generate a running number is using the `running_number()` helper function:
+
+```php
+use CleaniqueCoders\RunningNumber\Enums\Organization;
+
+$runningNumber = running_number()
+    ->type(Organization::PROFILE->value)
+    ->generate();
+
+echo $runningNumber; // Output: PROFILE001
+```
+
+### Using the Generator Class
+
+You can also use the Generator class directly:
+
+```php
+use CleaniqueCoders\RunningNumber\Generator;
+use CleaniqueCoders\RunningNumber\Enums\Organization;
+
+$runningNumber = Generator::make()
+    ->type(Organization::ORGANIZATION->value)
+    ->generate();
+
+echo $runningNumber; // Output: ORGANIZATION001
+```
+
+### Using the Facade
+
+For those who prefer facades:
+
+```php
+use CleaniqueCoders\RunningNumber\Facades\RunningNumber;
+use CleaniqueCoders\RunningNumber\Enums\Organization;
+
+$runningNumber = RunningNumber::type(Organization::DIVISION->value)->generate();
+
+echo $runningNumber; // Output: DIVISION001
+```
+
+## Common Scenarios
+
+### Invoice Numbers
+
+Generate sequential invoice numbers for your application:
+
+```php
+use CleaniqueCoders\RunningNumber\Enums\Organization;
+
+$invoiceNumber = running_number()
+    ->type('invoice')
+    ->generate();
+
+// Output: INVOICE001, INVOICE002, INVOICE003, ...
+```
+
+**Note**: Make sure to add `'invoice'` to your `config/running-number.php` types array.
+
+### Order Numbers
+
+Create sequential order numbers:
+
+```php
+$orderNumber = running_number()
+    ->type('order')
+    ->generate();
+
+// Output: ORDER001, ORDER002, ORDER003, ...
+```
+
+### Receipt Numbers
+
+Generate receipt numbers with lowercase formatting:
+
+```php
+$receiptNumber = running_number()
+    ->type('receipt')
+    ->toUpperCase(false)
+    ->generate();
+
+// Output: receipt001, receipt002, receipt003, ...
+```
+
+## Working with Models
+
+Integrate running numbers directly into your Eloquent models:
+
+```php
+use Illuminate\Database\Eloquent\Model;
+use CleaniqueCoders\RunningNumber\Enums\Organization;
+
+class Invoice extends Model
+{
+    protected static function booted()
+    {
+        static::creating(function ($invoice) {
+            $invoice->invoice_number = running_number()
+                ->type('invoice')
+                ->generate();
+        });
+    }
+}
+```
+
+Now every time you create a new invoice, it automatically gets a running number:
+
+```php
+$invoice = Invoice::create([
+    'customer_id' => 1,
+    'amount' => 100.00,
+]);
+
+echo $invoice->invoice_number; // INVOICE001
+```
+
+## Case Sensitivity
+
+By default, running numbers are generated in UPPERCASE. You can change this behavior:
+
+```php
+// Uppercase (default)
+$number = running_number()
+    ->type(Organization::PROFILE->value)
+    ->generate();
+// Output: PROFILE001
+
+// Lowercase
+$number = running_number()
+    ->type(Organization::PROFILE->value)
+    ->toUpperCase(false)
+    ->generate();
+// Output: profile002
+```
+
+## Multiple Types
+
+Generate running numbers for different types independently:
+
+```php
+// Each type maintains its own sequence
+$invoice = running_number()->type('invoice')->generate();   // INVOICE001
+$order = running_number()->type('order')->generate();       // ORDER001
+$invoice2 = running_number()->type('invoice')->generate();  // INVOICE002
+$order2 = running_number()->type('order')->generate();      // ORDER002
+```
+
+## Viewing Generated Numbers
+
+You can query the running numbers table directly to see all generated sequences:
+
+```php
+use CleaniqueCoders\RunningNumber\Models\RunningNumber;
+
+// Get all running number types
+$types = RunningNumber::all();
+
+// Get specific type
+$profileNumbers = RunningNumber::where('type', 'PROFILE')->first();
+echo $profileNumbers->number; // Current count
+
+// Access UUID
+echo $profileNumbers->uuid; // e.g., "550e8400-e29b-41d4-a716-446655440000"
+```
+
+## What's Next?
+
+Now that you've learned the basics, explore these topics:
+
+- **[Core Concepts](03-core-concepts.md)** - Understand how the package works under the hood
+- **[Configuration](../02-configuration/01-overview.md)** - Customize the package to your needs
+- **[Usage Guide](../03-usage/01-helper-functions.md)** - Learn advanced usage patterns
+- **[Advanced Topics](../04-advanced/01-custom-presenters.md)** - Create custom formatters and extend functionality
+
+## Quick Reference
+
+```php
+// Basic generation
+running_number()->type('invoice')->generate();
+
+// Lowercase
+running_number()->type('receipt')->toUpperCase(false)->generate();
+
+// Using enum
+use CleaniqueCoders\RunningNumber\Enums\Organization;
+running_number()->type(Organization::PROFILE->value)->generate();
+
+// In model events
+static::creating(function ($model) {
+    $model->number = running_number()->type('type')->generate();
+});
+```