dev-doc 0.2.2 → 0.2.4

package/README.md

@@ -1,116 +1,144 @@
 # dev-doc
 
-AI-powered codebase analyzer using Claude AI to generate comprehensive documentation and insights about your codebase.
+AI-powered codebase analyzer that automatically generates comprehensive documentation and insights about your codebase using AI.
 
-## Features
+## ✨ What is dev-doc?
 
-- 🔍 **Smart File Scanning**: Automatically discovers and reads source files from your codebase
-- 📦 **Intelligent Chunking**: Splits large files into manageable chunks for optimal AI processing
-- 🤖 **Claude AI Integration**: Leverages Claude AI for deep code analysis
-- 📊 **Multi-Level Analysis**: Provides both file-level and project-level insights
-- 🎯 **Framework Detection**: Automatically identifies your technology stack
-- 📝 **Structured Output**: Generates Markdown or JSON documentation
-- ⚙️ **Highly Configurable**: Customize ignored directories, file extensions, and more
+`dev-doc` scans your codebase, analyzes it with AI, and generates detailed documentation including:
+- **API Documentation**: Automatically detects and documents all endpoints, their relationships, and authentication flows
+- **Project Architecture**: Understands your tech stack and explains the overall structure
+- **Code Insights**: Provides explanations of functions, classes, and their roles
+- **Dependencies**: Maps relationships between different parts of your codebase
 
-## Installation
+All documentation is securely stored in your dashboard where you can access it anytime.
+
+## 🚀 Quick Start
+
+### Step 1: Install
 
 ```bash
 npm install -g dev-doc
 ```
 
-Or use it directly with npx:
+Or use it directly without installing:
 
 ```bash
 npx dev-doc ./src
 ```
 
-## Usage
+### Step 2: Get Your API Key
 
-### Basic Usage
+1. Visit [devdoc.tellecata.com](https://devdoc.tellecata.com)
+2. Sign up for a free account
+3. Navigate to your dashboard
+4. Copy your API key
 
-Simply provide the directory path you want to analyze:
+### Step 3: Add Your API Key
 
 ```bash
-dev-doc ./src
+dev-doc add-key <your-api-key>
 ```
 
-The analysis will be automatically saved to the database - you don't need to specify any output options.
+Or use the login alias:
 
-### CLI Options
+```bash
+dev-doc login <your-api-key>
+```
 
-- `[directory]`: Directory to analyze (default: current directory)
-- `--ignore <dirs>`: Comma-separated directories to ignore (default: `node_modules,.git,dist,build,.next`)
+You'll see a confirmation with your quota and usage information.
 
-**Note:** All AI processing is handled automatically - no API keys or configuration needed from end users!
+### Step 4: Analyze Your Codebase
+
+```bash
+dev-doc ./src
+```
 
-> **For Package Owners:** Credentials must be set as environment variables in the deployment environment. See [SECURITY.md](./SECURITY.md) for details.
+That's it! Your analysis will be automatically processed and saved to your dashboard.
 
-## Examples
+## 📖 Usage
 
-### Analyze Current Directory
+### Basic Commands
 
+**Analyze a directory:**
 ```bash
-dev-doc .
+dev-doc ./src
 ```
 
-### Analyze Specific Directory
+**Check your account status and quota:**
+```bash
+dev-doc status
+```
 
+**Add or update your API key:**
 ```bash
-dev-doc ./src
+dev-doc add-key <your-api-key>
 ```
 
-### Ignore Additional Directories
+### Options
 
+**Ignore specific directories:**
 ```bash
 dev-doc ./src --ignore node_modules,dist,tests,.next
 ```
 
-## Output
-
-The analysis is automatically saved to the database. The generated documentation includes:
-- **Statistics**: Total files analyzed and cached
-- **Technology Stack**: Detected frameworks and libraries
-- **Project Summary**: High-level architecture and insights
-- **File-by-File Analysis**: Detailed analysis for each file
-- **API Documentation**: Endpoints, relationships, and authentication flows
+Default ignored directories: `node_modules`, `.git`, `dist`, `build`, `.next`
 
-## How It Works
+## 📋 Examples
 
-1. **File Scanning**: Recursively scans the target directory for source files
-2. **Change Detection**: Compares file hashes with cache to identify changed files
-3. **Caching**: Uses cached results for unchanged files (dramatically faster on subsequent runs)
-4. **Parallel Processing**: Analyzes multiple files concurrently (3 by default)
-5. **Chunking**: Large files are split into manageable chunks for optimal processing
-6. **AI Analysis**: Each chunk is sent to Claude AI for analysis
-7. **Summarization**: Project-level summary is generated from all file analyses
-8. **Storage**: Results are automatically saved to the database
+### Analyze your entire project
 
-## Performance
+```bash
+dev-doc .
+```
 
-The analyzer is optimized for large codebases:
-- **Caching**: Only analyzes changed files on subsequent runs (up to **360x faster**)
-- **Parallel Processing**: Processes multiple files simultaneously
-- **Incremental Updates**: Updates only changed sections
+### Analyze a specific directory
 
-See [PERFORMANCE.md](./PERFORMANCE.md) for detailed performance benchmarks and optimization tips.
+```bash
+dev-doc ./src
+dev-doc ./backend
+dev-doc ./packages/utils
+```
 
-## Development
+### Exclude test files and build directories
 
 ```bash
-# Install dependencies
-npm install
+dev-doc ./src --ignore tests,coverage,build,.next
+```
+
+## 🎯 Features
+
+- **🔍 Smart Detection**: Automatically identifies APIs, endpoints, and their relationships
+- **⚡ Fast & Efficient**: Only processes changed files on subsequent runs
+- **📊 Comprehensive**: Generates both high-level architecture and detailed file-by-file documentation
+- **🔒 Secure**: Your code is processed securely and stored in your private dashboard
+- **🚀 No Configuration**: Works out of the box with sensible defaults
+
+## 💡 What You'll Get
 
-# Build
-npm run build
+After running an analysis, you'll have access to:
 
-# Run locally
-npm run dev ./src
+- **Complete API Documentation**: Every endpoint with parameters, responses, and relationships
+- **Authentication Flows**: Documented auth patterns and token usage
+- **Project Summary**: High-level overview of your architecture and tech stack
+- **File Documentation**: Detailed explanations of each file's purpose and key functions
+- **Dependency Mapping**: Clear understanding of how different parts connect
 
-# Or use ts-node directly
-npx ts-node src/cli.ts ./src
+All documentation is accessible through your dashboard at [devdoc.tellecata.com](https://devdoc.tellecata.com).
+
+## ❓ Troubleshooting
+
+**No API key found?**
+```bash
+dev-doc add-key <your-api-key>
+```
+
+**Check your quota and usage:**
+```bash
+dev-doc status
 ```
 
-## License
+**Need help?** Visit [devdoc.tellecata.com](https://devdoc.tellecata.com) for support and documentation.
 
-MIT
+## 📄 License
 
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dev-doc",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "AI-powered codebase analyzer using Claude AI to generate documentation and insights",
   "main": "dist/index.js",
   "bin": {
@@ -20,7 +20,7 @@
     "codebase",
     "analyzer"
   ],
-  "author": "",
+  "author": "Tellecata LLC",
   "license": "MIT",
   "repository": {
     "type": "git",