fixing README.md

Author: nikolay-e

.github/workflows/cd.yml

@@ -30,6 +30,8 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0  # Need full history for git bundle
 
       - name: Set up Python
         uses: actions/setup-python@v6
@@ -45,8 +47,9 @@ jobs:
           fi
 
       - name: Set version in version.py
+        env:
+          VERSION: ${{ github.event.inputs.version }}
         run: |
-          VERSION="${{ github.event.inputs.version }}"
           echo "Setting version to $VERSION"
           python - <<'PY'
           import os, re, pathlib
@@ -248,6 +251,9 @@ jobs:
         run: |
           git clone repo.bundle repo
           cd repo
+          git checkout main
+          echo "Current branch: $(git branch --show-current)"
+          echo "Current commit: $(git rev-parse HEAD)"
 
       - name: Push commit and tag to main
         working-directory: ./repo

.gitignore

@@ -270,8 +270,8 @@ pylint-report.txt
 # ==============================================================================
 # PyInstaller builds
 *.spec.bak
-treemapper
-treemapper.exe
+/treemapper
+/treemapper.exe
 
 # GitHub release artifacts
 release-notes.md

README.md

@@ -1,7 +1,7 @@
 # TreeMapper
 
-A tool for converting directory structures to YAML format, designed for use with Large Language Models (LLMs).
-TreeMapper maps your entire codebase into a structured YAML file, making it easy to analyze code, document projects, and
+A tool for converting directory structures to structured formats (YAML, JSON, or text), designed for use with Large Language Models (LLMs).
+TreeMapper maps your entire codebase into a structured file, making it easy to analyze code, document projects, and
 work with AI tools.
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/nikolay-e/TreeMapper/ci.yml)](https://github.com/nikolay-e/TreeMapper/actions)
@@ -18,10 +18,10 @@ pip install treemapper
 
 ## Usage
 
-Generate a YAML tree of a directory:
+Generate a structured representation of a directory:
 
 ```bash
-# Map current directory to stdout
+# Map current directory to stdout (YAML format)
 treemapper .
 
 # Map specific directory to stdout
@@ -33,11 +33,29 @@ treemapper . -o my-tree.yaml
 # Use "-" to explicitly output to stdout
 treemapper . -o -
 
+# Output in JSON format
+treemapper . --format json
+
+# Output in plain text format
+treemapper . --format text -o output.txt
+
+# Limit directory traversal depth
+treemapper . --max-depth 3
+
+# Skip file contents (structure only)
+treemapper . --no-content
+
+# Limit file size for content reading
+treemapper . --max-file-bytes 10000
+
 # Custom ignore patterns
 treemapper . -i ignore.txt
 
 # Disable all default ignores
 treemapper . --no-default-ignores
+
+# Combine multiple options
+treemapper . -o tree.json --format json --max-depth 5 --max-file-bytes 50000
 ```
 
 ### Options
@@ -49,10 +67,15 @@ Arguments:
   DIRECTORY                    Directory to analyze (default: current directory)
 
 Options:
-  -o, --output-file FILE      Output YAML file (default: stdout)
+  -o, --output-file PATH      Output file (default: stdout)
                              Use "-" to force stdout output
-  -i, --ignore-file FILE      Custom ignore patterns file
+  --format {yaml,json,text}   Output format (default: yaml)
+  -i, --ignore-file PATH      Custom ignore patterns file
   --no-default-ignores        Disable all default ignores (.gitignore, .treemapperignore, etc.)
+  --max-depth N               Maximum depth to traverse (default: unlimited)
+  --no-content                Skip reading file contents (structure-only mode)
+  --max-file-bytes N          Maximum file size to read in bytes (default: unlimited)
+                             Larger files will show a placeholder
   -v, --verbosity [0-3]       Logging verbosity (default: 0)
                              0=ERROR, 1=WARNING, 2=INFO, 3=DEBUG
   --version                   Show version and exit
@@ -75,6 +98,7 @@ Use `--no-default-ignores` to disable all default ignores and only use patterns
 
 ### Example Output
 
+**YAML format (default):**
 ```yaml
 name: my-project
 type: directory
@@ -94,6 +118,52 @@ children:
       Documentation here...
 ```
 
+**JSON format (`--format json`):**
+```json
+{
+  "name": "my-project",
+  "type": "directory",
+  "children": [
+    {
+      "name": "src",
+      "type": "directory",
+      "children": [
+        {
+          "name": "main.py",
+          "type": "file",
+          "content": "def main():\n    print(\"Hello World\")\n"
+        }
+      ]
+    },
+    {
+      "name": "README.md",
+      "type": "file",
+      "content": "# My Project\nDocumentation here...\n"
+    }
+  ]
+}
+```
+
+**Text format (`--format text`):**
+```
+================================================================================
+Directory Tree: my-project
+================================================================================
+
+src/ (directory)
+  main.py (file)
+    --- BEGIN CONTENT ---
+    def main():
+        print("Hello World")
+    --- END CONTENT ---
+
+README.md (file)
+  --- BEGIN CONTENT ---
+  # My Project
+  Documentation here...
+  --- END CONTENT ---
+```
+
 ## License
 
 Apache License 2.0 - see [LICENSE](LICENSE) for details.