added readme content and biome setup

Author: PratikDev

README.md

@@ -1,3 +1,111 @@
 # TreeEx
 
-CLI tool that analyzes directory structure and outputs a JSON tree
+A CLI tool that analyzes directory structures and outputs them as JSON. Built with Bun and TypeScript.
+
+## Why TreeEx?
+
+Sometimes you just need a quick way to get a directory's structure as JSON - maybe for documentation, feeding into an LLM, or just understanding a codebase. TreeEx does exactly that, with sensible defaults and cross-platform support.
+
+## Installation
+
+### From source
+
+Requirements:
+- Bun
+- Git
+
+```bash
+git clone https://github.com/pratikdev/treeex.git
+cd treeex
+bun install
+```
+
+## Building
+
+```bash
+# Build for current platform
+bun run build
+
+# Check [package.json](./package.json) for more options
+```
+
+This produces a standalone binary in the `build/` directory for your OS
+
+## Usage
+
+```bash
+# cd into the build directory
+cd build
+
+# Analyze current directory (`/build` directory will be empty though)
+treeEx
+
+# Analyze a specific path
+treeEx ../src
+
+# Limit depth
+treeEx --depth 3
+
+# Unlimited depth
+treeEx --depth inf
+
+# Ignore additional patterns
+treeEx -i "*.log" -i "*.tmp"
+
+# Include everything (disable default ignores)
+treeEx --no-default-ignore
+```
+
+## Output Format
+
+TreeEx outputs a JSON tree structure:
+
+```json
+{
+  "name": "root",
+  "type": "directory",
+  "children": [
+    {
+      "name": "src",
+      "type": "directory",
+      "children": [
+        {
+          "name": "index.ts",
+          "type": "file",
+          "children": []
+        }
+      ]
+    },
+    {
+      "name": "package.json",
+      "type": "file",
+      "children": []
+    }
+  ]
+}
+```
+
+## Default Ignore Patterns
+
+By default, TreeEx ignores common noise directories and files:
+
+- `.git`, `.svn`, `.hg`, `.CVS`
+- `node_modules`, `vendor`
+- `build`, `dist`, `out`
+- `.vscode`, `.DS_Store`
+
+Use `--no-default-ignore` to include everything.
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `-d, --depth <level>` | Maximum depth level (default: 20, use "inf" for unlimited) |
+| `-i, --ignore <pattern>` | Glob pattern to ignore (can be used multiple times) |
+| `--no-default-ignore` | Disable default ignore patterns |
+| `-v, --version` | Show version |
+| `-h, --help` | Show help |
+
+## License
+
+MIT

biome.json

@@ -0,0 +1,34 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true
+	},
+	"files": {
+		"ignoreUnknown": false
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "tab"
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "double"
+		}
+	},
+	"assist": {
+		"enabled": true,
+		"actions": {
+			"source": {
+				"organizeImports": "on"
+			}
+		}
+	}
+}

bun.lock

@@ -16,11 +16,18 @@
 		"build:windows": "bun build index.ts --compile --target=bun-windows-x64 --outfile build/treeEx-windows-x64.exe",
 		"build:all": "bun run build:linux && bun run build:macos && bun run build:macos-arm && bun run build:windows",
 		"build:clean": "rm -rf build/",
-		"typecheck": "tsc --noEmit"
+		"typecheck": "tsc --noEmit",
+		"lint": "biome lint .",
+		"format": "biome format . --write",
+		"check": "biome check ."
 	},
 	"devDependencies": {
+		"@biomejs/biome": "^2.3.10",
 		"@types/bun": "latest"
 	},
+	"dependencies": {
+		"commander": "^14.0.2"
+	},
 	"peerDependencies": {
 		"typescript": "^5"
 	},
@@ -33,8 +40,5 @@
 		"tool"
 	],
 	"author": "Pratik Dev",
-	"license": "MIT",
-	"dependencies": {
-		"commander": "^14.0.2"
-	}
+	"license": "MIT"
 }