Skip to content

Commit 83c6922

Browse files
committed
Clarify the extension's workflow and API tool integration in the README
1 parent efdfda9 commit 83c6922

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,13 @@ Available in <a href="https://marketplace.visualstudio.com/items?itemName=robert
1919
- Initialize chatbots—don't scrape responses
2020
- Free forever—community effort
2121

22-
⭐️ **The workflow**
22+
⭐️ **How it works?**
2323

2424
Select folders and files for context, type instructions, and pick your favorite chatbot—to continue in the browser, or call a model provider of choice—to stay in the editor.
2525

26-
Once the response is ready, suggested multi-file changes can be integrated with the codebase after you review them in a transparent and safe way.
27-
28-
⭐️ **How it works?**
26+
The extension then constructs a message in an XML-like format. It consists of your prompt, edit format instructions, and file context.
2927

30-
It's really simple! Whenever you inititalize a new chat or make an API call, a message in XML-like format is constructed. It constists of three segments: prompt, edit format and context. First two are repeated after context [for better adherence](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.).
28+
> The prompt and edit format instructions are repeated after the context [for better model adherence](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.).
3129
3230
```
3331
Implement a subtract method.
@@ -36,7 +34,9 @@ Whenever proposing a new or updated file use the Markdown Code Block syntax. Eac
3634
</system>
3735
<files>
3836
<file path="src/calculator.ts">
37+
<![CDATA[
3938
export const addNumbers = (a: number, b: number) => a + b;
39+
]]>
4040
</file>
4141
</files>
4242
Implement a subtract method.
@@ -45,7 +45,9 @@ Whenever proposing a new or updated file use the Markdown Code Block syntax. Eac
4545
</system>
4646
```
4747

48-
A single response contains applicable changes across all affected files.
48+
Once you receive the model's response, suggested multi-file changes can be integrated with the codebase after you review them in a transparent and safe way.
49+
50+
> You can undo any changes made with CWC.
4951
5052
## <span style="background-color: #fbb100; color: black; padding: 0.2em 0.6em; border-radius: 999px">Chatbot initialization</span>
5153

@@ -79,7 +81,7 @@ It uses a simple [content script](https://github.com/robertpiosik/CodeWebChat/bl
7981
8082
## <span style="background-color: #fbb100; color: black; padding: 0.2em 0.6em; border-radius: 999px">API Tools</span>
8183

82-
Get started with generous free tier from Google via [AI Studio / API Keys](https://aistudio.google.com/api-keys), or any other OpenAI-API compatible model provider, e.g. [OpenRouter](https://openrouter.ai/settings/keys).
84+
Anything CWC can do in the connected browser, it can do calling a model provider directly in the editor. Get started with generous free tier from Google via [AI Studio](https://aistudio.google.com/api-keys).
8385

8486
**🛠️ Edit Context** \
8587
Modify, create or delete files based on natural language instructions.

‎packages/vscode/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "gemini-coder",
33
"displayName": "Code Web Chat",
44
"description": "CWC initializes your favorite chatbot with code and instructions, hands-free!",
5-
"version": "1.411.0",
5+
"version": "1.412.0",
66
"scripts": {
77
"build": "npx vsce package --no-dependencies",
88
"vscode:prepublish": "rimraf out && npm run compile",

0 commit comments

Comments
 (0)