Skip to content

Commit fd7a658

Browse files
committed
Update README to highlight local model compatibility and refine messaging for clarity and conciseness
1 parent d43106a commit fd7a658

1 file changed

Lines changed: 13 additions & 16 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,29 @@ Context-first AI coding for VS Code, Cursor, and others. Free, open-source, and
1010
- Model providers—_Gemini API, OpenRouter, local Ollama, etc._
1111

1212
✅ **Apply responses**—changes integration in whole, truncated, compared and diff edit formats \
13-
✅ **Fully featured**—code completions, commit messages, checkpoints, and more
13+
✅ **Fully featured**—code completions, commit messages, checkpoints, and more \
14+
🏠️ **Local friendly**—easy on small models thanks to zero tool calling
1415

1516
<p>
1617
<img src="https://github.com/robertpiosik/CodeWebChat/raw/HEAD/packages/shared/src/media/screenshot.png" alt="Screenshot" />
1718
</p>
1819

1920
## Introduction
2021

21-
🧐 **The limitations of LLMs**
22+
**The limitations of LLMs**
2223

23-
Large language models (LLMs) are trained on vast datasets targeting many use cases. For code generation, a model's training involves analyzing millions of simulated problem-solving flows, such as arriving at the accepted answer from a given StackOverflow question. For the purpose of agentic coding, models are trained on an additional layer of data that simulates gathering context and planning its next steps.
24+
Large language models are trained on vast, curated datasets targeting many use cases. For code generation, model's training involves analyzing millions of simulated problem-solving flows, such as arriving at the accepted answer from a given StackOverflow question. For the purpose of agentic coding, models are trained on an additional layer of data that simulates gathering context and planning its next steps.
2425

25-
Because the model is only as smart as examples it has seen in its pre-training stage, the possible coverage of real-world problems when approached at a high level is fundamentally limited.
26+
Because the model is only as smart as examples it has seen in its training, and all it does is mindless pattern matching—letting it face big, real-world, noisy codebases all by itself could be above its true capabilities, severly huriting accuracy and cost-efficiency.
2627

27-
Therefore, CWC is designed to align with LLMs' true capabilities—that is, code generation in a controlled signal-to-noise ratio environment. Controlled by you, the engineer.
28+
**Context-first approach**
2829

29-
🧠 **Guide the model with context**
30-
31-
Unlike coding agents that require detailed instructions to understand your intent and locate relevant files, with CWC you provide fine-grained context up front, allowing simple, even vague instructions.
30+
Meet a non-agentic workflow—select files that make an environment for the task, enter instructions, and send message with your favorite chatbot or a model provider of choice.
3231

3332
> [!TIP]
34-
> LLMs are pattern matchers—they love examples! Include some you believe will help the model understand the goal better.
35-
36-
Meet the CWC's non-agentic workflow—select folders and files, enter instructions, and send message in a new web chat or with an API provider of choice.
33+
> LLMs are pattern matchers—they love examples! Steer the model to higher quality outputs, like no coding agent can.
3734
38-
Constructed message is simple and focuses the model's whole attention on the task:
35+
Constructed messages, in their simple form, free from the tool-calling noise focus the model's whole attention on the task. Example:
3936

4037
```
4138
Implement a subtract function.
@@ -58,11 +55,11 @@ Implement a subtract function.
5855
> [!NOTE]
5956
> The prompt and edit format instructions are repeated after the context [for better accuracy](https://cookbook.openai.com/examples/gpt4-1_prompting_guide#:~:text=If%20you%20have%20long%20context%20in%20your%20prompt%2C%20ideally%20place%20your%20instructions%20at%20both%20the%20beginning%20and%20end%20of%20the%20provided%20context%2C%20as%20we%20found%20this%20to%20perform%20better%20than%20only%20above%20or%20below.).
6057
61-
Once the response is generated, sophisticated parser extracts code blocks with suggested edits for one-click multi-file changes integration.
58+
Once the response is generated, a sophisticated parser extracts code blocks with file edits for one-click changes integration.
6259

63-
## Chatbot initialization
60+
## Browser integration
6461

65-
Install the [open-source](https://github.com/robertpiosik/CodeWebChat/blob/dev/packages/browser) Connector in your browser and never copy & paste again.
62+
Install CWC's Connector extension in your favorite browser to place messages, use projects feature, set model, incognito mode, and more. Like all of Code Web Chat, the extension is [open-source](https://github.com/robertpiosik/CodeWebChat/blob/dev/packages/browser) and works with minimal permissions for your absolute security and privacy.
6663

6764
- [Chrome Web Store](https://chromewebstore.google.com/detail/code-web-chat-connector/ljookipcanaglfaocjbgdicfbdhhjffp)
6865
- [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/code-web-chat-connector/)
@@ -101,7 +98,7 @@ Install the [open-source](https://github.com/robertpiosik/CodeWebChat/blob/dev/p
10198
Anything CWC can do in chatbots, it can do calling model providers directly from the editor.
10299

103100
> [!TIP]
104-
> Get started with generous free tiers from [Google](https://aistudio.google.com/api-keys), [Mistral](https://console.mistral.ai/api-keys) or [Cerebras](https://cloud.cerebras.ai/).
101+
> Get started with model providers like [Google](https://aistudio.google.com/api-keys), [Mistral](https://console.mistral.ai/api-keys) or [Cerebras](https://cloud.cerebras.ai/).
105102
106103
**🛠️ Edit Context** \
107104
Modify, create or delete files based on natural language instructions.

0 commit comments

Comments
 (0)