Skip to content

Commit fb3e3d3

Browse files
authored
Fix grammar and clarity issues in README.md
Corrected grammatical errors and improved clarity in README.
1 parent f880c3e commit fb3e3d3

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@ src="https://img.shields.io/github/stars/editor-code-assistant/eca?style=flat-sq
4141

4242
A Free and OpenSource editor-agnostic tool that aims to easily link LLMs <-> Editors, giving the best UX possible for AI pair programming using a well-defined protocol. The server is written in Clojure and heavily inspired by the [LSP protocol](https://microsoft.github.io/language-server-protocol/) which is a success case for this kind of integration.
4343

44-
The protocol makes easier for other editors integrate and having a server in the middle helps adding more features quickly, some examples:
44+
The protocol makes it easier for other editors to integrate, and having a server in the middle helps add more features quickly, some examples:
4545
- Tool call management
4646
- Multiple LLM interaction
47-
- Telemetry of features usage
47+
- Telemetry of feature usage
4848
- Single way to configure for any editor
4949
- Same UX, easy to onboard people and teams.
5050

51-
With the LLMs models race, the differences between them tend to be irrelevant in the future, but UX on how to edit code or plan changes is something that will exist, ECA helps editors focus on that.
51+
With the LLMs models race, the differences between them tend to be irrelevant in the future, but UX on how to edit code or plan changes is something that will exist; ECA helps editors focus on that.
5252

53-
**How it works**: Editors spawn the server via `eca server` and communicate via stdin/stdout, similar to LSPs. Supported editors already download latest server on start and require no extra configuration.
53+
**How it works**: Editors spawn the server via `eca server` and communicate via stdin/stdout, similar to LSPs. Supported editors already download the latest server on start and require no extra configuration.
5454

5555
## Quickstart
5656

@@ -65,21 +65,24 @@ Install the plugin for your editor and ECA server will be downloaded and started
6565

6666
### 2. Set up your first model
6767

68-
To use ECA, you need to configure at least one model / provider (_tip: Github Copilot offer free models!_). See the [Models documentation](https://eca.dev/models#adding-and-configuring-models) for detailed instructions:
68+
To use ECA, you need to configure at least one model / provider (_tip: Github Copilot offer free models!_).
69+
70+
See the [Models documentation](https://eca.dev/models#adding-and-configuring-models) for detailed instructions:
6971

7072
1. Type in the chat `/login`.
71-
2. Chose your provider
73+
2. Choose your provider
7274
3. Follow the steps to configure the key or auth for your provider.
75+
4. This will add to the global config.json the config for that provider.
7376

7477
or [configure manually](https://eca.dev/models/).
7578

7679
**Note**: For other providers or custom models, see the [custom providers documentation](https://eca.dev/models#custom-providers).
7780

78-
### 3. Start chatting
81+
### 3. Start chatting, completing, rewriting
7982

80-
Once your model is configured, you can start using ECA's chat interface in your editor to ask questions, review code, and work together on your project.
83+
Once your model is configured, you can start using ECA's features interface in your editor to ask questions, review code, and work together on your project.
8184

82-
Type `/init` to ask ECA to create/update a [AGENTS.md](http://agents.md) file which will help ECA on next iterations have good context about your project standards.
85+
Type `/init` to ask ECA to create/update a [AGENTS.md](http://agents.md) file, which will help ECA in the next iterations have good context about your project standards.
8386

8487
## Roadmap
8588

0 commit comments

Comments
 (0)