Skip to content

Commit 20c9c35

Browse files
committed
docs
1 parent 297c40e commit 20c9c35

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55

66
# ECA (Editor Code Assistant)
77

8-
:warning: The project is still alpha, expect bugs and WIP features, but being consistently improved and maintained, feedback is more than welcome.
9-
108
_Demo using [eca-emacs](https://github.com/editor-code-assistant/eca-emacs)_
119
![demo](https://raw.githubusercontent.com/editor-code-assistant/eca-emacs/master/demo.gif)
1210

@@ -21,12 +19,10 @@ _Demo using [eca-vscode](https://github.com/editor-code-assistant/eca-vscode)_
2119
<a href="./docs/protocol.md"><strong>protocol</strong></a>
2220
</p>
2321
<hr>
22+
23+
<a href="https://github.com/editor-code-assistant/eca/stargazers"><img alt="GitHub Stars" title="Total number of GitHub stars the ECA project has received"
2424

25-
## Rationale
26-
27-
<img src="images/rationale.jpg" width="500">
28-
29-
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.
25+
## Features
3026

3127
- **Editor-agnostic** protocol for any editor to integrate.
3228
- **Single configuration**: Configure eca making it work the same in any editor via global or local configs.
@@ -35,6 +31,14 @@ A Free and OpenSource editor-agnostic tool that aims to easily link LLMs <-> Edi
3531
- **Context** support: giving more details about your code to the LLM.
3632
- **Multi models**: OpenAI, Anthropic, Ollama local models, and custom user config models.
3733

34+
## Rationale
35+
36+
<img src="images/rationale.jpg" width="500">
37+
38+
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.
39+
40+
The protocol makes easier for other editors integrate and having a server in the middle helps adding more features quickly like exporting metrics of features usage or single way to configure it for any editor.
41+
3842
## Installation
3943

4044
Eca is written in Clojure and compiled into a native binary via graalvm. You can download the [native binaries from Github Releases](https://github.com/editor-code-assistant/eca/releases) or use the install script for convenience:
@@ -55,7 +59,9 @@ bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/maste
5559

5660
Editors should spawn the server via `eca server` and communicate via stdin/stdout. Logs are printed to stderr, use `--verbose` to log client<->server communication or `--log-level debug` to log more info like LLM responses.
5761

58-
## Supported editors
62+
Supported editors already download latest server on start and require no extra configuration
63+
64+
### Supported editors
5965

6066
- [Emacs](https://github.com/editor-code-assistant/eca-emacs)
6167
- [VsCode](https://github.com/editor-code-assistant/eca-vscode)

0 commit comments

Comments
 (0)