Skip to content

Commit 6d50ede

Browse files
authored
docs
1 parent 5ef1ac0 commit 6d50ede

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ A Free and OpenSource editor-agnostic tool that aims to easily link LLMs <-> Edi
3636

3737
## Installation
3838

39-
Eca is written in Clojure and compiled into a native binary via graalvm. You can download the binaries from Github Releases or use the install script for convenience:
39+
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:
4040

4141
Stable release:
4242

@@ -47,23 +47,23 @@ bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/maste
4747
nightly build:
4848

4949
```bash
50-
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install) --version nightly
50+
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install) --version nightly --dir ~/
5151
```
5252

5353
## Usage
5454

55-
Editors should spawn the server via `eca server` and communicate via stdin/stdout.
55+
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.
5656

5757
## Supported editors
5858

5959
- [Emacs](https://github.com/editor-code-assistant/eca-emacs)
6060
- [VsCode](https://github.com/editor-code-assistant/eca-vscode)
61-
- Intellij: Planned
61+
- Intellij: Planned, help welcome
6262
- Vim: Planned, help welcome
6363

6464
## Protocol
6565

66-
The protocol can be found [here](./docs/protocol.md), it follows the same standard of LSP documentation, defining how server and client communicate with each other.
66+
The protocol can be found [here](./docs/protocol.md), it follows the same standard of LSP documentation, defining how clients and server communicate with each other.
6767

6868
## Roadmap
6969

@@ -77,3 +77,7 @@ You can start eca with `--log-level debug` which should log helpful information
7777

7878
Contributions are very welcome, please open an issue for discussion or a pull request.
7979
For developer details, check [this doc](./docs/development.md).
80+
81+
## Support the project
82+
83+
Consider [sponsoring the project](https://github.com/sponsors/ericdallo) to help grow faster, the support helps to keep the project going, being updated and maintained!

0 commit comments

Comments
 (0)