feat: automate README updates with config file contents

Author: tonystar

.github/workflows/update-readme.yml

@@ -0,0 +1,28 @@
+name: Update README with Config Files
+
+on:
+  push:
+    paths:
+      - '.gitconfig.example'
+      - '.gitconfig-github'
+      - '.gitconfig-gitlab'
+      - '.github/workflows/update-readme.yml'
+      - 'scripts/update-readme.py'
+
+jobs:
+  update-readme:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Update README with config file contents
+        run: python3 scripts/update-readme.py
+      
+      - name: Commit changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add README.md
+          git diff --quiet && git diff --staged --quiet || (git commit -m "docs: update README with config file contents" && git push)

README.md

@@ -16,6 +16,8 @@ You'll need the following configuration files. Replace all `PLACE_HOLDER` values
 
 ## `.gitconfig` (Global Git Configuration)
 
+<!-- GITCONFIG_EXAMPLE_START -->
+
 ```ini
 # ====================================================================
 # Global Git Configuration (Usually ~/.gitconfig)
@@ -46,8 +48,12 @@ You'll need the following configuration files. Replace all `PLACE_HOLDER` values
     path = .gitconfig-gitlab
 ```
 
+<!-- GITCONFIG_EXAMPLE_END -->
+
 ## `.gitconfig-github` (GitHub-Specific Configuration)
 
+<!-- GITCONFIG_GITHUB_START -->
+
 ```ini
 # ====================================================================
 # GitHub-specific Git configuration
@@ -62,8 +68,12 @@ You'll need the following configuration files. Replace all `PLACE_HOLDER` values
     email = YOUR_GITHUB_ID+USERNAME@users.noreply.github.com
 ```
 
+<!-- GITCONFIG_GITHUB_END -->
+
 ## `.gitconfig-gitlab` (GitLab-Specific Configuration)
 
+<!-- GITCONFIG_GITLAB_START -->
+
 ```ini
 # ====================================================================
 # GitLab-specific Git configuration
@@ -78,6 +88,8 @@ You'll need the following configuration files. Replace all `PLACE_HOLDER` values
     email = YOUR_GITLAB_ID-USERNAME@users.noreply.gitlab.com
 ```
 
+<!-- GITCONFIG_GITLAB_END -->
+
 # How to Verify
 
 1. Clone a repository from GitHub/GitLab.

scripts/update-readme.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+"""Update README.md with content from config files."""
+
+import re
+from pathlib import Path
+
+CONFIG_FILES = {
+    'GITCONFIG_EXAMPLE': '.gitconfig.example',
+    'GITCONFIG_GITHUB': '.gitconfig-github',
+    'GITCONFIG_GITLAB': '.gitconfig-gitlab',
+}
+
+def update_readme():
+    readme_path = Path('README.md')
+    content = readme_path.read_text()
+    
+    for marker, config_file in CONFIG_FILES.items():
+        config_content = Path(config_file).read_text()
+        
+        # Replace section between markers with config file content
+        pattern = f'(<!-- {marker}_START -->)\n\n```ini\n.*?\n```\n\n(<!-- {marker}_END -->)'
+        replacement = f'\\1\n\n```ini\n{config_content}```\n\n\\2'
+        
+        content = re.sub(pattern, replacement, content, flags=re.DOTALL)
+    
+    readme_path.write_text(content)
+
+if __name__ == '__main__':
+    update_readme()