Enhance README.md: Add project structure and technology stack sections, update installation instructions, and clarify build outputs. Include project roadmap with completed, in-progress, and planned features for better project visibility.

Author: darekrossman

README.md

@@ -11,6 +11,39 @@ An MCP (Model Context Protocol) server that lets users and autonomous agents gen
 - **Resource: `config://defaults`** - View effective configuration defaults
 - **Prompts** - Helper prompts for LLMs to use the tools effectively
 
+## Project Structure
+
+```
+fluxlora-mcp/
+├── bin/                   # Executable scripts
+├── scripts/               # Dev utility scripts
+├── src/
+│   ├── config/            # Environment configuration
+│   ├── mcp/               # MCP server implementation
+│   ├── prompts/           # System prompts for LLMs
+│   ├── resources/         # MCP resources
+│   ├── services/          # External service integrations
+│   │   ├── fal/           # Fal.ai client for image generation
+│   │   ├── fs/            # Filesystem operations
+│   │   └── hf/            # HuggingFace Hub client
+│   ├── tools/             # MCP tool implementations
+│   │   ├── discover_loras.ts
+│   │   ├── generate_image.ts
+│   │   └── save_image_to_disk.ts
+│   ├── types/             # TypeScript type definitions
+│   └── utils/             # Utility functions
+├── IMPLEMENTATION-PLAN.md # Current status and roadmap
+└── README.md              # This file
+```
+
+## Technology Stack
+
+- **TypeScript**: Type-safe JavaScript for robust development
+- **Zod**: Runtime validation for input/output schemas
+- **MCP SDK**: Integration with the Model Context Protocol
+- **Fal.ai Client**: API client for image generation
+- **HuggingFace Hub**: API client for discovering LoRA models
+
 ## Installation
 
 ```bash
@@ -27,11 +60,12 @@ npm install
 Copy the example environment file and update with your settings:
 
 ```bash
-cp packages/server/.env.example packages/server/.env
+cp .env.example .env
 ```
 
 Required environment variables:
 - `FAL_KEY` - Your Fal API key (get one from [Fal.ai](https://fal.ai))
+- `HF_TOKEN` - Optional Hugging Face API token for increased rate limits
 
 ## Development
 
@@ -51,11 +85,9 @@ npm test
 # Run the MCP Inspector with your development server
 npm run inspect
 
-# Run the MCP Inspector with your production build
-npm run inspect:prod
-
-# Run the MCP Inspector with your bundled build
-npm run inspect:bundle
+# Lint and typecheck your code
+npm run lint
+npm run typecheck
 ```
 
 ### Using the MCP Inspector
@@ -80,12 +112,12 @@ To use the Inspector:
 The project supports multiple build options:
 
 1. **TypeScript Build**: Standard TypeScript compilation (`npm run build`)
-   - Output: `packages/server/dist/`
-   - Usage: `node packages/server/dist/index.js`
+   - Output: `dist/`
+   - Usage: `node dist/index.js`
 
 2. **Optimized Bundle**: Single-file bundle with esbuild (`npm run bundle`)
-   - Output: `packages/server/dist/bundle/index.js`
-   - Usage: `node packages/server/dist/bundle/index.js`
+   - Output: `dist/bundle/index.js`
+   - Usage: `node dist/bundle/index.js`
    - Benefits: Faster startup, smaller deployment size, simpler dependencies
 
 ## Usage
@@ -121,23 +153,52 @@ console.log(loras.results);
 
 ```typescript
 const result = await client.invokeTool('save_image_to_disk', {
-  imageUrl: 'https://example.com/image.png',
-  filename: 'my-image.png'
+  url: 'https://example.com/image.png'
 });
 
 console.log(result.filePath);
 ```
 
+## Project Roadmap
+
+### Completed
+- ✅ MCP server with protocol integration
+- ✅ Fal.ai client implementation
+- ✅ Image generation with parameter validation
+- ✅ HuggingFace Hub integration for LoRA discovery
+- ✅ Image storage utilities with security checks
+- ✅ Configuration resource implementation
+- ✅ System prompts for LLMs
+
+### In Progress
+- 🔄 Testing infrastructure
+- 🔄 Enhanced LoRA discovery with better style mapping
+- 🔄 Local `.safetensor` file scanning
+
+### Planned
+- ⏳ LoRA resource implementation
+- ⏳ API response caching
+- ⏳ Logging infrastructure
+- ⏳ Performance optimization
+- ⏳ Documentation site
+- ⏳ Release automation
+
+### Future Enhancements
+- Batch image generation
+- Grid view outputs
+- ControlNet integration
+- Video and audio generation
+- Optional web UI
+
 ## Documentation
 
 For more detailed documentation, see:
 
-- [Product Requirements Document](docs/PRD.md)
 - [Implementation Plan](IMPLEMENTATION-PLAN.md)
 
 ## Dependencies
 
-- MCP TypeScript SDK: `@modelcontextprotocol/typescript-sdk`
+- MCP TypeScript SDK: `@modelcontextprotocol/sdk`
 - Fal Client: `@fal-ai/client`
 - HuggingFace Hub: `@huggingface/hub`
 - Zod: `zod`