Revise README.md for clarity and conciseness, updating sections on usage, features, and installation instructions
This commit is contained in:
85
README.md
85
README.md
@@ -1,79 +1,48 @@
|
|||||||
# Prompter
|
# 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.
|
- **Reduce repository clutter** - Share only essential files instead of everything
|
||||||
- **LLM underperforming?** Cut the noise for sharper, more accurate responses.
|
- **Improve AI responses** - Eliminate irrelevant context for better results
|
||||||
- **Better AI coding?** Select just the right context to optimize 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**
|
- **Smart File Selection & Token Counting**
|
||||||
Precisely filter files and estimate token usage instantly for optimized, cost-effective prompts.
|
Filter files and track token usage for efficient, economical prompts
|
||||||
|
|
||||||
- **Optimized XML Prompt**
|
- **XML-Based Prompt Structure**
|
||||||
Structured file trees, CodeMaps, content, and instructions in XML for maximum LLM clarity.
|
Organize file trees, CodeMaps, and instructions in XML for better AI comprehension
|
||||||
|
|
||||||
- **Structured XML Diffs**
|
- **Clean XML Diff Application**
|
||||||
Converts LLM-generated XML edits into precise, reviewable diffs—works at any file size.
|
Transform AI-generated XML changes into clear, reviewable diffs at any scale
|
||||||
|
|
||||||
- **Codemap Extraction**
|
- **Intelligent Code Scanning**
|
||||||
Scans files locally to extract classes, functions, and references, minimizing tokens and hallucinations. Auto-detects referenced types.
|
Extract code structure locally to reduce tokens and prevent hallucinations
|
||||||
|
|
||||||
- **Mac-Native Performance**
|
- **Cross-Platform Support**
|
||||||
Built for macOS with native speed and responsiveness—because performance matters.
|
Designed for any VSCode platform with native performance and responsiveness
|
||||||
|
|
||||||
- **Clipboard Integration**
|
- **Direct Clipboard Support**
|
||||||
Copy structured prompts into any AI chat app—your data stays local, no external API needed.
|
Copy structured prompts to any AI platform with your data remaining local
|
||||||
|
|
||||||
- **Works with Any Model**
|
- **Privacy-Focused Design**
|
||||||
Compatible with OpenAI, Anthropic, DeepSeek, Gemini, Azure, OpenRouter, and local models—private and offline when you need it.
|
Process everything locally without sending data to third parties
|
||||||
|
|
||||||
- **Privacy First**
|
## Quick Start
|
||||||
Local models, offline scanning, and direct clipboard use—no intermediaries required.
|
|
||||||
|
|
||||||
## Installation
|
1. Install the extension in VS Code
|
||||||
|
2. Select relevant files through the Prompter sidebar
|
||||||
*(Note: Installation steps are assumed based on the VS Code context from other files. Adjust as needed.)*
|
3. Generate and copy a structured XML prompt
|
||||||
1. Clone the repository:
|
4. Paste into your AI tool of choice
|
||||||
```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.
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
We welcome contributions! To get started:
|
Contributions welcome!
|
||||||
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.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
Built with ❤️ by the Prompter team.
|
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.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user