Provide API Documentation on the Web (#12)

.github/workflows/deploy-to-github-pages.yml

@@ -0,0 +1,13 @@
+name: deploy-to-github-pages
+
+on:
+  release:
+    types: [released]
+
+permissions: {}
+
+jobs:
+  publish-pages:
+    permissions:
+      contents: write
+    uses: cable8mm/.github/.github/workflows/deploy-to-github-pages.yml@main

README.md

@@ -2,9 +2,17 @@
 
 [![code-style](https://github.com/cable8mm/xeed/actions/workflows/code-style.yml/badge.svg)](https://github.com/cable8mm/xeed/actions/workflows/code-style.yml)
 [![run-tests](https://github.com/cable8mm/xeed/actions/workflows/run-tests.yml/badge.svg)](https://github.com/cable8mm/xeed/actions/workflows/run-tests.yml)
+[![Packagist Version](https://img.shields.io/packagist/v/cable8mm/xeed)](https://packagist.org/packages/cable8mm/xeed)
+[![Packagist Downloads](https://img.shields.io/packagist/dt/cable8mm/xeed)](https://packagist.org/packages/cable8mm/xeed/stats)
+[![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/cable8mm/xeed/php)](https://packagist.org/packages/cable8mm/xeed)
+![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/cable8mm/xeed/symfony%2Fconsole)
+[![Packagist Stars](https://img.shields.io/packagist/stars/cable8mm/xeed)](https://github.com/cable8mm/xeed/stargazers)
+[![Packagist License](https://img.shields.io/packagist/l/cable8mm/xeed)](https://github.com/cable8mm/xeed/blob/main/LICENSE.md)
 
 The Xeed is to generate new model, seed, database seed, factory and migration files for Laravel based on data from the existing database table.
 
+We have provided the API Documentation on the web. For more information, please visit https://www.palgle.com/xeed/ ❤️
+
 ## Features
 
 - [x] Database testing is supported

composer.json

@@ -1,9 +1,11 @@
 {
     "name": "cable8mm/xeed",
-    "description": "The Xeed is to generate a new seed file based on data from the existing database table.",
+    "description": "The Xeed is to generate new model, seed, database seed, factory and migration files for Laravel based on data from the existing database table.",
     "keywords": [
-        "seed",
         "laravel",
+        "factory",
+        "seed",
+        "migration",
         "generator",
         "xeed"
     ],
@@ -48,4 +50,4 @@
         "inspect": "./vendor/bin/pint --test",
         "apidoc": "doctum.phar update doctum.php --output-format=github --no-ansi --no-progress"
     }
-}
+}