updates

Author: ngmisl

.github/workflows/update-llms.yml

@@ -0,0 +1,57 @@
+name: Update llms.txt
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+  workflow_dispatch:  # Allow manual triggering
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-llms:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
+      - name: Install dependencies
+        run: |
+          uv pip install .
+
+      - name: Generate llms.txt
+        run: python llms.py
+
+      - name: Check for changes
+        id: changes
+        run: |
+          if git diff --quiet llms.txt; then
+            echo "No changes to llms.txt"
+            echo "changes=false" >> $GITHUB_OUTPUT
+          else
+            echo "Changes detected in llms.txt"
+            echo "changes=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Commit and push if changed
+        if: steps.changes.outputs.changes == 'true'
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add llms.txt
+          git commit -m "chore: update llms.txt [skip ci]"
+          git push

README.md

@@ -1,4 +1,5 @@
 [![CodeQL Advanced](https://github.com/ngmisl/llmstxt/actions/workflows/codeql.yml/badge.svg)](https://github.com/ngmisl/llmstxt/actions/workflows/codeql.yml)
+[![Update llms.txt](https://github.com/ngmisl/llmstxt/actions/workflows/update-llms.yml/badge.svg)](https://github.com/ngmisl/llmstxt/actions/workflows/update-llms.yml)
 
 # llmstxt
 
@@ -46,17 +47,41 @@ uv pip install -e ".[dev]"
 
 ## Usage
 
+### Local Usage
+
 ```bash
 # Generate llms.txt from current directory
 python llms.py
 ```
 
 The script will:
-
 1. Scan the current directory recursively
 2. Process files according to .gitignore rules
 3. Generate `llms.txt` with compressed content
 
+### GitHub Actions Integration
+
+This tool can automatically generate and update `llms.txt` in your repository using GitHub Actions. To set it up:
+
+1. Copy the workflow file:
+   ```bash
+   mkdir -p .github/workflows
+   curl -o .github/workflows/update-llms.yml https://raw.githubusercontent.com/ngmisl/llmstxt/main/.github/workflows/update-llms.yml
+   ```
+
+2. Commit and push the workflow file:
+   ```bash
+   git add .github/workflows/update-llms.yml
+   git commit -m "chore: add llmstxt workflow"
+   git push
+   ```
+
+The workflow will:
+- Run automatically on pushes to main/master
+- Generate/update llms.txt
+- Commit and push changes if needed
+- Can be manually triggered from the Actions tab
+
 ## Output Format
 
 The generated `llms.txt` file follows this structure: