Skip to content

Commit 9cab9ca

Browse files
committed
Clarify prompt examples and streamline command and feature descriptions in README
1 parent ca730ef commit 9cab9ca

1 file changed

Lines changed: 23 additions & 25 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ In the world of AI coding, agents like Claude Code or Codex rely on "Function Ca
4747

4848
```
4949
<files>[the selected files]</files>
50-
<system>[edit format instructions]</system>
50+
<system>[edit format (e.g. whole or diff) instructions]</system>
5151
[user-typed prompt]
5252
```
5353

@@ -73,7 +73,7 @@ In the world of AI coding, agents like Claude Code or Codex rely on "Function Ca
7373
[code before cursor]<missing_text>[user-typed prompt]</missing_text>[code after cursor]
7474
</file>
7575
</files>
76-
[code at cursor instructions]
76+
[predefined instructions]
7777
```
7878

7979
</details>
@@ -84,7 +84,7 @@ In the world of AI coding, agents like Claude Code or Codex rely on "Function Ca
8484
```
8585
<files>[the selected files]</files>
8686
<system>[output format]</system>
87-
[find relevant files instructions]
87+
[predefined instructions]
8888
[user-typed prompt]
8989
```
9090

@@ -148,16 +148,14 @@ Install the [browser extension](https://github.com/robertpiosik/CodeWebChat/tree
148148
149149
## Calling APIs
150150

151-
CWC supports your software development efforts without leaving the editor. Bring Your Own Key (BYOK) for a model provider of choice. Self-host with [Ollama](https://ollama.com/search) or [LM Studio](https://lmstudio.ai/).
151+
**CWC includes built-in API tools.** Bring Your Own Key (BYOK) for a model provider of choice. Self-host with [Ollama](https://ollama.com/search) or [LM Studio](https://lmstudio.ai/).
152152

153-
**Built-in API tools:**
154-
155-
- Intelligent Update
156-
- Edit Context
157-
- Code at Cursor
158-
- Find Relevant Files
159-
- Commit Messages
160-
- Voice Input
153+
- **Intelligent Update**—Integrate changes from malformed responses.
154+
- **Edit Context**—Pair-programming using natural language instructions.
155+
- **Code at Cursor**—Accurate inline code from reasoning models.
156+
- **Find Relevant Files**—Find files using natural language description.
157+
- **Commit Messages**—Meaningful summaries of changes in your style.
158+
- **Voice Input**—Transcribe speech to text in the prompt field.
161159

162160
## Enterprise security
163161

@@ -171,28 +169,28 @@ CWC supports your software development efforts without leaving the editor. Bring
171169

172170
### Code at Cursor
173171

174-
- `Code Web Chat: Code at Cursor` - Get an inline snippet while using the current context.
175-
- `Code Web Chat: Code at Cursor using...` - Inline snippet with configuration selection.
176-
- `Code Web Chat: Code at Cursor with Instructions` - Inline snippet with instructions.
177-
- `Code Web Chat: Code at Cursor with Instructions using...` - Inline snippet with instructions and configuration selection.
172+
- `Code at Cursor` - Get an inline snippet while using the current context.
173+
- `Code at Cursor using...` - Inline snippet with configuration selection.
174+
- `Code at Cursor with Instructions` - Inline snippet with instructions.
175+
- `Code at Cursor with Instructions using...` - Inline snippet with instructions and configuration selection.
178176

179177
### Checkpoints
180178

181-
- `Code Web Chat: Checkpoints` - Restore the overall workspace state to the saved checkpoint.
182-
- `Code Web Chat: Create New Checkpoint` - Save the current state of the workspace.
179+
- `Checkpoints` - Restore the overall workspace state to the saved checkpoint.
180+
- `Create New Checkpoint` - Save the current state of the workspace.
183181

184182
### Context
185183

186-
- `Code Web Chat: Apply Context` - Apply a saved context or save the current file selection.
187-
- `Code Web Chat: Add File to Context` - Search and add file (or parent folder via file action) to the context.
188-
- `Code Web Chat: Remove File from Context` - Search and remove file (or parent folder via file action) from the context.
189-
- `Code Web Chat: Search Files for Context` - Search and add files containing specific keywords to the context.
190-
- `Code Web Chat: Copy Context` - Copy XML-formatted checked files from the Workspace view to the clipboard.
191-
- `Code Web Chat: Copy Context of Open Editors` - Copy XML-formatted checked files from the Open Editors view to the clipboard.
184+
- `Apply Context` - Apply a saved context or save the current file selection.
185+
- `Add File to Context` - Search and add file (or parent folder via file action) to the context.
186+
- `Remove File from Context` - Search and remove file (or parent folder via file action) from the context.
187+
- `Search Files for Context` - Search and add files containing specific keywords to the context.
188+
- `Copy Context` - Copy XML-formatted checked files from the Workspace view to the clipboard.
189+
- `Copy Context of Open Editors` - Copy XML-formatted checked files from the Open Editors view to the clipboard.
192190

193191
### Commit messages
194192

195-
- `Code Web Chat: Commit Changes` - Generate commit message and commit.
193+
- `Commit Changes` - Generate commit message and commit.
196194

197195
## Contributing
198196

0 commit comments

Comments
 (0)