Skip to content

Commit eff1bd5

Browse files
authored
Update README.md
1 parent 21e4e3a commit eff1bd5

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ _Demo using [eca-emacs](https://github.com/editor-code-assistant/eca-emacs)_
1313

1414
<img src="images/rationale.jpg" width="500">
1515

16-
An 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.
16+
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.
1717

18-
- **Editor-agnostic** protocol for any editor integrate.
18+
- **Editor-agnostic** protocol for any editor to integrate.
19+
- **Single configuration**: Configure eca making it work the same in any editor.
1920
- **Chat** interface: ask questions, review diffs, work together with an agent in your codebase.
20-
- **Streaming responses** and structured error handling.
21+
- **Context** support: giving more details about your code to the LLM.
2122
- **Pluggable models**: Ollama local models, OpenAI, Anthropic, more on the way.
22-
- **Single configuration**: Configure eca behavior making it feel the same in any editor.
2323

2424
## Installation
2525

@@ -37,12 +37,12 @@ sudo bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/
3737

3838
## Usage
3939

40-
Editors should spawn server via `eca server` and communicate via stdin/stdout.
40+
Editors should spawn the server via `eca server` and communicate via stdin/stdout.
4141

4242
## Configuration
4343

4444
Check all available configs [here](./src/eca/config.clj#L15).
45-
There are 3 ways to configure ECA following following this order of priority:
45+
There are 3 ways to configure ECA following this order of priority:
4646

4747
### InitializationOptions (convenient for editors)
4848

@@ -54,7 +54,7 @@ Client editors can pass custom settings when sending the `initialize` request vi
5454
}
5555
```
5656

57-
### Config file (conveninent for users)
57+
### Config file (convenient for users)
5858

5959
`.eca/config.json`
6060

@@ -92,7 +92,7 @@ name: Funny rule
9292

9393
### Config
9494

95-
Just add to your config the `:rules` pointing to md files that will be searched from the workspace root if not an absolute path:
95+
Just add to your config the `:rules` pointing to `.md` files that will be searched from the workspace root if not an absolute path:
9696

9797
```javascript
9898
{
@@ -117,4 +117,4 @@ Check the planned work [here](https://github.com/orgs/editor-code-assistant/proj
117117

118118
## Contributing
119119

120-
Contributions are very welcome, please open a issue for discussion or pull request.
120+
Contributions are very welcome, please open an issue for discussion or a pull request.

0 commit comments

Comments
 (0)