Skip to content

Commit 591fab6

Browse files
committed
docs
1 parent a1850e7 commit 591fab6

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,9 @@ A Free and OpenSource editor-agnostic tool that aims to easily link LLMs <-> Edi
3838

3939
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.
4040

41-
## Usage
41+
## Getting started
4242

43-
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.
44-
45-
Supported editors already download latest server on start and require no extra configuration
43+
Install the plugin for your editor and ECA server will be downloaded and started automatically.
4644

4745
### Supported editors
4846

@@ -51,6 +49,12 @@ Supported editors already download latest server on start and require no extra c
5149
- Intellij: Planned, help welcome
5250
- Vim: Planned, help welcome
5351

52+
## How it works
53+
54+
Editors 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.
55+
56+
Supported editors already download latest server on start and require no extra configuration
57+
5458
## Roadmap
5559

5660
Check the planned work [here](https://github.com/orgs/editor-code-assistant/projects/1/views/1).

0 commit comments

Comments
 (0)