docs/publish-readme (#57)

* Remove export-ignore from README.md in .gitattributes.

* Add `zero-to-prod/package-helper` dependency and binary script configuration.

* Add documentation publishing guide and automatic publishing script instructions to README.md

* Add `zero-to-prod-data-model` script for publishing README to documentation directory.

* Update `zero-to-prod-data-model` script to adjust target path for data-model directory.

Author: zero-to-prod

.gitattributes

@@ -11,7 +11,6 @@
 /LICENSE.md               export-ignore
 /LOCAL_DEVELOPMENT.md     export-ignore
 /phpunit.xml              export-ignore
-/README.md                export-ignore
 /SECURITY.md              export-ignore
 /test.sh                  export-ignore
 /dock                     export-ignore

README.md

@@ -17,7 +17,9 @@
 - [Introduction](#introduction)
     - [Why Use DataModel?](#why-use-datamodel)
 - [Installation](#installation)
-    - [Additional Packages](#additional-packages)
+- [Documentation Publishing](#documentation-publishing)
+  - [Automatic Documentation Publishing](#automatic-documentation-publishing)
+- [Additional Packages](#additional-packages)
 - [Features](#features)
     - [Type-Safe](#recursive-hydration)
     - [Recursive Instantiation](#recursive-hydration)
@@ -88,6 +90,39 @@ You can install the package via Composer:
 composer require zero-to-prod/data-model
 ```
 
+## Documentation Publishing
+
+You can publish this README to your local documentation directory.
+
+This can be useful for providing documentation for AI agents.
+
+This can be done using the included script:
+
+```bash
+# Publish to default location (./docs/zero-to-prod/data-model)
+vendor/bin/zero-to-prod-data-model
+
+# Publish to custom directory
+vendor/bin/zero-to-prod-data-model /path/to/your/docs
+```
+
+#### Automatic Documentation Publishing
+
+You can automatically publish documentation by adding the following to your `composer.json`:
+
+```json
+{
+  "scripts": {
+    "post-install-cmd": [
+      "zero-to-prod-data-model"
+    ],
+    "post-update-cmd": [
+      "zero-to-prod-data-model"
+    ]
+  }
+}
+```
+
 ### Additional Packages
 
 - [DataModelHelper](https://github.com/zero-to-prod/data-model-helper): Helpers for a `DataModel`.

bin/zero-to-prod-data-model

@@ -0,0 +1,33 @@
+#!/usr/bin/env php
+<?php
+
+/**
+ * Zero-to-Prod Factory Documentation Publisher
+ *
+ * Publishes the README.md file to the user's documentation directory.
+ */
+
+require getcwd().'/vendor/autoload.php';
+
+use Zerotoprod\PackageHelper\PackageHelper;
+
+$target_path = getcwd().'/docs/zero-to-prod/data-model/';
+if (isset($argv[1])) {
+    $target_path = rtrim($argv[1], '/').'/';
+}
+
+$source_file = __DIR__.'/../README.md';
+
+if (!file_exists($source_file)) {
+    fwrite(STDERR, "Error: Not found $source_file\n");
+    exit(1);
+}
+
+try {
+    PackageHelper::copy($source_file, $target_path);
+    exit(0);
+} catch (RuntimeException $e) {
+    fwrite(STDERR, "Error: ".$e->getMessage()."\n");
+    exit(1);
+}
+

composer.json

@@ -39,7 +39,8 @@
     }
   ],
   "require": {
-    "php": ">=8.1.0"
+    "php": ">=8.1.0",
+    "zero-to-prod/package-helper": "^1.1.3"
   },
   "require-dev": {
     "phpunit/phpunit": "^10.0"
@@ -61,5 +62,8 @@
     "files": [
       "./tests/functions.php"
     ]
-  }
+  },
+  "bin": [
+    "bin/zero-to-prod-data-model"
+  ]
 }