Skip to content

Commit ee2e427

Browse files
committed
Clarify CWC's purpose and features in the README
1 parent 9cc5fcd commit ee2e427

1 file changed

Lines changed: 35 additions & 26 deletions

File tree

โ€ŽREADME.mdโ€Ž

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,21 @@
1919

2020
## What is CWC?
2121

22-
CWC is a non-agentic 100% free & open source VS Code extension for AI-assisted programming.
22+
CWC enables developers getting the best quality AI-assistance with a game-changing cost efficiency.
23+
24+
โœŒ๏ธ 100% free and open source!
2325

2426
Guiding Principles:
2527

26-
- initialize all popular chatbots
27-
- don't overengineer AI-assistance
28+
- initialize popular chatbots but don't game them
29+
- donโ€™t complicate what can be simple
2830
- never collect any usage data
2931
- be robust and lightweight (~1 MB)
3032

3133
CWC is for you if:
3234

33-
- you want the best performance out of LLMs
34-
- you want to code with your favourite chatbot
35+
- you're an experienced engineer working on a large project
36+
- you're a student or hobbyist on a budget
3537
- you love open source software! ๐Ÿซถ
3638

3739
<p>
@@ -40,30 +42,29 @@ CWC is for you if:
4042

4143
## You own the context
4244

43-
Other tools try to "guess" what pieces of the codebase matter for the given task, often struggling to get it right. They workaround this problem by overloading context with excessive information, hurting model's performance and your wallet.
45+
Other tools try to "guess" what pieces of the codebase matter for the given task, often struggling to get it right. They workaround this by overloading context hurting model's performance and your wallet.
4446

4547
CWC works differently:
4648

4749
- **You select** which folders and files are relevant to the task
48-
- **You decide** what examples of coding conventions will work best
49-
- **You know** exactly how much tokens you have in the context
50+
- **You know** exactly how many tokens you have in the context
5051

51-
The result? Unmatched in cost, speed and accuracy AI assistance.
52+
The result? Unmatched in accuracy and cost AI assistance.
5253

5354
> Too many tokens fighting for attention may _decrease_ performance due to being too "distracting", diffusing attention too broadly and decreasing a signal to noise ratio in the features. ~Andrej Karpathy
5455
5556
## Web chats
5657

57-
As everyone have their own favorite chatbot, each with unique capabilities, CWC lets you initialize them hands-free!
58+
Use your favorite chatbot no more tediously copy-pasting contents of files you want to include with your instructions.
5859

5960
**The feature has two modes:**
6061

61-
- General - select context and type instructions
62-
- Code Completions - select context and place cursor
62+
- General - ask anything
63+
- Code Completions - code completion at cursor
6364

64-
Generated prompts are simple and adjustable.
65+
Prompts can be copied or sent to the browser hands-free!
6566

66-
**_Apply Chat Response_** is a smart tool that automatically integrates chat responses with the codebase, either refactoring with API ("Truncated" edit format), replacing original files in place ("Whole" edit format) or patching with diffs ("Diff" edit format).
67+
**_Apply Chat Response_** is a smart tool that automatically integrates chat responses with the codebase by modyfing exisitng files or creating new ones.
6768

6869
**Supported chatbots: _(alphabetically)_**
6970

@@ -87,29 +88,37 @@ The Connector extension is available in [Chrome Web Store](https://chromewebstor
8788
8889
### Practice single-turns
8990

90-
Chat conversations are only a construct of product interfaces, they hurt the quality of responses from the model and once your context is "poisoned" it will not recover. Whenever you're not satisfied with a reponse, **the best practice is to alawys refine your initial instructions and re-initialize**.
91+
Chat conversations are only a construct of product interfaces, they hurt the quality of responses from the model and once your context is "poisoned" it will not recover. Whenever you're not satisfied with a reponse, **the best practice is to alawys refine your initial instructions and re-initialize a chat**.
92+
93+
## API Tools
9194

92-
## ๐Ÿงฐ Tools
95+
CWC will elevate your workflow with must-have API features.
9396

94-
CWC will elevate your coding with battle-tested, must have API features.
97+
### Code completions
9598

96-
### ๐Ÿ› ๏ธ Code completions
99+
The tool is designed to provide you with the highest quality autocomplete suggestions at the cost of latency. Intented to be used on-demand through the Tools tab, via the command palette or a keybinding. Setup multiple configurations and choose between them based on difficulty of the completion.
97100

98-
Use state-of-the-art reasoning models for accurate code completions. Selected context is included with every request.
101+
โœ“ Includes selected context
102+
<br />
103+
โœ“ Works great with any model
99104

100-
### ๐Ÿ› ๏ธ File refactoring
105+
### File refactoring
101106

102-
Modify the active file based on natural language instructions. Selected context is included with every request.
107+
Modify a file based on natural language instructions.
103108

104-
### ๐Ÿ› ๏ธ Apply chat response
109+
โœ“ Includes selected context
110+
<br />
111+
โœ“ Reliable single-file edits
105112

106-
Automatically integrate chat responses with your codebase. The tool detects whether the clipboard-held chat response contains complete files (replaces them), diffs (possible fallback with the file refactoring tool without context) or truncated fragments (always uses file refactoring tool without context).
113+
### Commit messages
107114

108-
### ๐Ÿ› ๏ธ Commit messages
115+
Generate meaningful commit messages. The tool first attaches affected files, then the customizable instructions, then diff of changes. Not lobotomized context ensures unmatched accuracy.
109116

110-
Generate meaningful commit messages based on contents of affected files and diffs of changes.
117+
โœ“ Includes affected files in full
118+
<br />
119+
โœ“ Customizable instructions
111120

112-
### ๐Ÿ”‘ Bring your own API keys
121+
### Bring your own API keys
113122

114123
**Predefined providers: _(alphabetically)_**
115124

0 commit comments

Comments
ย (0)