docs: update README for clarity and feature enhancements

Author: tanhongit

README.md

@@ -1,121 +1,108 @@
-# github-project-php 👋
+# GitHub Project PHP
 
 <p align="center">
 <a href="#"><img src="https://img.shields.io/github/license/cslant/github-project-php.svg?style=flat-square" alt="License"></a>
 <a href="https://github.com/cslant/github-project-php/releases"><img src="https://img.shields.io/github/release/cslant/github-project-php.svg?style=flat-square" alt="Latest Version"></a>
 <a href="https://packagist.org/packages/cslant/github-project-php"><img src="https://img.shields.io/packagist/dt/cslant/github-project-php.svg?style=flat-square" alt="Total Downloads"></a>
 <a href="https://github.com/cslant/github-project-php/actions/workflows/setup_test.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/github-project-php/setup_test.yml?label=tests&branch=main" alt="Test Status"></a>
 <a href="https://github.com/cslant/github-project-php/actions/workflows/php-cs-fixer.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/github-project-php/php-cs-fixer.yml?label=code%20style&branch=main" alt="Code Style Status"></a>
+</p>
 
-## 📝 Introduction
+## Introduction
 
-GitHub Project PHP is a package that helps you manage your Github projects in PHP.
+GitHub Project PHP is a Laravel package that helps you manage your GitHub Projects (V2) in PHP.
 
-It provides a simple and easy-to-use webhooks system to get the GitHub project's actions and implement comments on all activities in the project.
+It provides a simple webhook system to receive GitHub project events and automatically generate activity comments on issues and pull requests.
 
-## Available Field Type Templates
-
-### Standard Field Types
+## Features
 
-1. **text** - For simple text fields
-2. **number** - For numeric fields
-3. **date** - For date fields (formatted as Y-m-d)
-4. **single_select** - For single-select dropdowns with color support
-5. **multi_select** - For multi-select fields
-6. **checkbox** - For boolean/toggle fields
-7. **textarea** - For long text content with diff view
-8. **iteration** - For iteration/sprint fields
-9. **labels** - For label/tag fields
-10. **assignees** - For user assignment fields
-11. **milestone** - For milestone tracking
-12. **unsupported** - Fallback for unknown field types
+- **Webhook Integration**: Receive and process GitHub Projects V2 webhook events
+- **Queue Support**: Process webhook events asynchronously for better performance
+- **API Endpoint**: Generate comment messages via REST API
+- **12+ Field Type Templates**: Built-in templates for all GitHub Project field types
+- **Customizable Templates**: Publish and customize Blade templates
+- **GitHub GraphQL API**: Direct integration with GitHub's GraphQL API
 
-## 📋 Requirements
+## Requirements
 
-- PHP ^8.3
+- PHP ^8.4
+- Laravel ^11.0|^12.0
 - [Composer](https://getcomposer.org/)
-- [Laravel](https://laravel.com/) ^10.0
 
-## 🔧 Installation
-
-You can install this package via Composer:
+## Installation
 
 ```bash
 composer require cslant/github-project-php
 ```
 
-### Customizing Templates
+## Available Field Type Templates
+
+| Field Type      | Description                                |
+|-----------------|--------------------------------------------|
+| `text`          | Simple text fields                         |
+| `number`        | Numeric fields                             |
+| `date`          | Date fields (Y-m-d format)                 |
+| `single_select` | Single-select dropdowns with color support |
+| `multi_select`  | Multi-select fields                        |
+| `checkbox`      | Boolean/toggle fields                      |
+| `textarea`      | Long text content with diff view           |
+| `iteration`     | Iteration/sprint fields                    |
+| `labels`        | Label/tag fields                           |
+| `assignees`     | User assignment fields                     |
+| `milestone`     | Milestone tracking                         |
+| `unsupported`   | Fallback for unknown field types           |
+
+## Usage
+
+See the [GitHub Project PHP Documentation](https://docs.cslant.com/github-project-php/usage) for detailed usage instructions.
 
-You can publish and customize the templates by running:
+### Customizing Templates
 
 ```bash
 php artisan vendor:publish --tag=github-project-views
 ```
 
-This will copy the templates to `resources/views/vendor/github-project/md/field_types/` where you can modify them.
-
-## 🚀 Usage
-
-See the [Usage - GitHub Project PHP Documentation](https://docs.cslant.com/github-project-php/usage)
-for a list of usage.
-
-Please check and update some configurations in the documentation.
+This copies templates to `resources/views/vendor/github-project/md/field_types/`.
 
 ### Template Variables
 
-All field type templates receive the following variables:
-
-- `$fieldName` - The display name of the field
-- `$fieldType` - The type of the field (e.g., 'text', 'number')
-- `$fromValue` - The previous value of the field
-- `$toValue` - The new value of the field
-- `$fieldData` - Raw field data from the webhook
-
-### Adding Custom Field Types
+All field type templates receive:
 
-To add support for a custom field type:
+- `$fieldName` - Display name of the field
+- `$fieldType` - Type of the field
+- `$fromValue` - Previous value
+- `$toValue` - New value
+- `$fieldData` - Raw webhook data
 
-1. Create a new template file in the `field_types` directory
-2. Name it with your field type (e.g., `custom_type.blade.php`)
-3. The template will automatically be used when a field of that type is encountered
+### API Endpoint
 
-### Styling
+Generate comment messages via API:
 
-GitHub Flavored Markdown (GFM) is supported. You can use:
+```
+POST /github-project/generate-comment
+Content-Type: application/json
 
-- `**bold**` for bold text
-- `*italic*` for italic text
-- `` `code` `` for inline code
-- ```code blocks``` for multi-line code
-- [links](https://example.com) for URLs
-- HTML is also supported for more complex formatting
+{
+  "payload": { ... }
+}
+```
 
-### Best Practices
+### Queue Configuration
 
-1. Keep messages concise but informative
-2. Use consistent formatting
-3. Include relevant context
-4. Handle null/empty values gracefully
-5. Use emoji sparingly for visual cues
+Enable queue processing in your config:
 
-### Example Custom Template
+```php
+// config/github-project.php
+'is_queue_enabled' => true,
+```
 
-Here's an example of a custom field type template:
+## Documentation
 
-```blade
-@if($fromValue != null && $toValue != null)
-    **`{{ $fieldName }}`** changed from **`{{ $fromValue }}`** to **`{{ $toValue }}`**
-@elseif($toValue)
-    **`{{ $fieldName }}`** set to **`{{ $toValue }}`**
-@else
-    **`{{ $fieldName }}`** cleared
-@endif
-```
+Full documentation available at [docs.cslant.com/github-project-php](https://docs.cslant.com/github-project-php)
 
-## 📖 Official Documentation
+## Changelog
 
-Please see the [GitHub Project PHP Documentation](https://docs.cslant.com/github-project-php) for more
-information.
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
 ## License