Revise README.md for clarity and conciseness, updating sections on usage, features, and installation instructions

This commit is contained in:
2025-03-13 08:52:22 +00:00
parent 19a5dc658e
commit d2b09eefbe

View File

@@ -1,79 +1,48 @@
# Prompter
Code smarter with AI—no more messy copy-pasting. Prompter structures your prompts and applies AI changes seamlessly, streamlining your coding workflow.
Enhance your coding with AI—Prompter organizes your prompts and implements AI changes effortlessly, improving your development workflow.
## Why Prompter?
## Why Use Prompter?
- **Too much bloat in your repo?** Stop zipping everything—send only the files that matter.
- **LLM underperforming?** Cut the noise for sharper, more accurate responses.
- **Better AI coding?** Select just the right context to optimize results.
- **Reduce repository clutter** - Share only essential files instead of everything
- **Improve AI responses** - Eliminate irrelevant context for better results
- **Optimize coding assistance** - Target exactly what you need for precise AI help
Prompter empowers you to work efficiently with AI, reducing token waste and improving clarity.
Prompter helps you collaborate efficiently with AI, minimizing token usage and enhancing clarity.
## Features
## Key Features
- **Advanced File Selection & Token Estimation**
Precisely filter files and estimate token usage instantly for optimized, cost-effective prompts.
- **Smart File Selection & Token Counting**
Filter files and track token usage for efficient, economical prompts
- **Optimized XML Prompt**
Structured file trees, CodeMaps, content, and instructions in XML for maximum LLM clarity.
- **XML-Based Prompt Structure**
Organize file trees, CodeMaps, and instructions in XML for better AI comprehension
- **Structured XML Diffs**
Converts LLM-generated XML edits into precise, reviewable diffs—works at any file size.
- **Clean XML Diff Application**
Transform AI-generated XML changes into clear, reviewable diffs at any scale
- **Codemap Extraction**
Scans files locally to extract classes, functions, and references, minimizing tokens and hallucinations. Auto-detects referenced types.
- **Intelligent Code Scanning**
Extract code structure locally to reduce tokens and prevent hallucinations
- **Mac-Native Performance**
Built for macOS with native speed and responsiveness—because performance matters.
- **Cross-Platform Support**
Designed for any VSCode platform with native performance and responsiveness
- **Clipboard Integration**
Copy structured prompts into any AI chat app—your data stays local, no external API needed.
- **Direct Clipboard Support**
Copy structured prompts to any AI platform with your data remaining local
- **Works with Any Model**
Compatible with OpenAI, Anthropic, DeepSeek, Gemini, Azure, OpenRouter, and local models—private and offline when you need it.
- **Privacy-Focused Design**
Process everything locally without sending data to third parties
- **Privacy First**
Local models, offline scanning, and direct clipboard use—no intermediaries required.
## Quick Start
## Installation
*(Note: Installation steps are assumed based on the VS Code context from other files. Adjust as needed.)*
1. Clone the repository:
```bash
git clone <repository-url>
```
2. Open the project in VS Code.
3. Install dependencies:
```bash
npm install
```
4. Build the extension:
```bash
npm run compile
```
5. Press `F5` in VS Code to launch the extension in a development window.
## Usage
1. Open your project in VS Code.
2. Use the Prompter interface to select files and estimate tokens.
3. Generate a structured XML prompt via the clipboard.
4. Paste into your preferred AI model (e.g., ChatGPT, Claude, or a local LLM).
5. Apply the returned XML diffs directly through Prompter for seamless integration.
1. Install the extension in VS Code
2. Select relevant files through the Prompter sidebar
3. Generate and copy a structured XML prompt
4. Paste into your AI tool of choice
## Contributing
We welcome contributions! To get started:
1. Fork the repository.
2. Create a feature branch: `git checkout -b my-feature`.
3. Commit your changes: `git commit -m "Add my feature"`.
4. Push to your branch: `git push origin my-feature`.
5. Open a pull request.
See `vsc-extension-quickstart.md` for development setup and testing details.
Contributions welcome!
---
Built with ❤️ by the Prompter team.
Code smarter with AI—no more messy copy-pasting. Prompter structures your prompts and applies AI changes seamlessly, streamlining your coding workflow.