update

.gitattributes

@@ -0,0 +1,9 @@
+* text=auto
+
+/.github export-ignore
+/screenshot export-ignore
+/tests export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.nitpick.json export-ignore

.github/workflows/fix-php-code-styling.yml

@@ -0,0 +1,27 @@
+name: "Fix PHP Code Styling"
+
+on:
+  push:
+    paths:
+      - '**.php'
+
+permissions:
+  contents: write
+
+jobs:
+  php-code-styling:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Fix PHP code style issues
+        uses: aglipanci/laravel-pint-action@2.4
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: Fix styling

.github/workflows/tests.yml → .github/workflows/run-tests.yml

@@ -1,4 +1,4 @@
-name: Tests
+name: run-tests
 
 on: [ push ]
 

README.md

@@ -0,0 +1,96 @@
+# Laravel ERD
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/recca0120/laravel-erd.svg?style=flat-square)](https://packagist.org/packages/recca0120/laravel-erd)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/recca0120/laravel-erd/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/recca0120/laravel-erd/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/recca0120/laravel-erd/fix-php-code-styling.yml?branch=main&label=code%20styling&style=flat-square)](https://github.com/recca0120/laravel-erd/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/recca0120/laravel-erd.svg?style=flat-square)](https://packagist.org/packages/recca0120/laravel-erd)
+
+Laravel ERD automatically generates Entity-Relationship Diagrams from your Laravel models and displays them
+using [Vuerd](https://github.com/dineug/erd-editor).
+
+## Preview
+
+Here's a sample of what you can expect, generated from [migrations](database/migrations)
+and [models](tests/fixtures/Models):
+
+![Vuerd](screenshot/vuerd.jpg)
+
+## Requirements
+
+| Lang    | Version                 |
+|:--------|:------------------------|
+| PHP     | 7.4, 8.0, 8.1, 8.2, 8.3 |
+| Laravel | 8, 9, 10, 11            |
+
+## Installation
+
+Install the package via Composer:
+
+```bash
+composer require recca0120/laravel-erd:^0.1 --dev
+```
+
+## Usage
+
+### Step 1: Generate the ERD
+
+Run the following command:
+
+```bash
+php artisan erd:generate
+```
+
+Step 2: View the ERD
+
+Open the following URL in your browser:
+
+http://localhost/laravel-erd
+
+## Advanced Usage
+
+### Exclude Tables and Save to a Different Filename
+
+#### step 1.
+
+Run the command:
+
+```bash
+php artisan erd:generate --file=exclude-users.sql --exclude=users
+```
+
+#### step 2.
+
+Open the URL:
+
+http://localhost/laravel-erd/exclude-users
+
+### Generate an SVG Version
+
+#### step 1.
+
+Install [erd-go](https://github.com/kaishuu0123/erd-go)
+and [graphviz-dot.js](https://github.com/kaishuu0123/graphviz-dot.js) using:
+
+```bash
+php artisan erd:install 
+```
+
+#### step 2.
+
+Generate the SVG file:
+
+```php
+php artisan generate --file=laravel-erd.svg
+```
+
+#### step 3.
+
+View the SVG version:
+
+http://localhost/laravel-erd/laravel-erd.svg
+
+![svg](tests/fixtures/expected_artisan.svg)
+
+> The SVG file can be found at storage/framework/cache/laravel-erd.
+
+Feel free to ask if you have any questions or need further assistance!