Skip to content

Commit 06f0bf0

Browse files
committed
docs
1 parent dbba36e commit 06f0bf0

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ The protocol makes easier for other editors integrate and having a server in the
4949

5050
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.
5151

52-
## Getting started
52+
**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+
54+
## Quickstart
5355

5456
### 1. Install the editor plugin
5557

@@ -62,19 +64,19 @@ Install the plugin for your editor and ECA server will be downloaded and started
6264

6365
### 2. Set up your first model
6466

65-
To use ECA, you need to configure at least one model with your API key. See the [Models documentation](https://eca.dev/models#adding-and-configuring-models) for detailed instructions on:
67+
To use ECA, you need to configure at least one model with your API key (_tip: Github Copilot offer free models!_). See the [Models documentation](https://eca.dev/models#adding-and-configuring-models) for detailed instructions on:
6668

67-
- Setting up API keys for OpenAI, Anthropic, or Ollama
69+
- Setting up API keys for OpenAI, Anthropic, Copilot or Ollama
6870
- Adding and customizing models
6971
- Configuring custom providers
7072

71-
**Quick start**: Create a `.eca/config.json` file in your project root with your API key:
73+
**Quick start**: Create a `~/.config/eca/config.json` file with your API key:
7274

73-
```json
75+
```javascript
7476
{
7577
"providers": {
76-
"openai": {"key": "your-openai-api-key-here"},
77-
"anthropic": {"key": "your-anthropic-api-key-here"}
78+
"openai": {"key": "your-openai-api-key-here"},
79+
"anthropic": {"key": "your-anthropic-api-key-here"}
7880
}
7981
}
8082
```
@@ -85,11 +87,7 @@ To use ECA, you need to configure at least one model with your API key. See the
8587

8688
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.
8789

88-
Type `/init` to ask ECA to create a [AGENTS.md](http://agents.md) file which will help ECA on next iterations have good context about your project standards.
89-
90-
## How it works
91-
92-
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.
90+
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.
9391

9492
## Roadmap
9593

@@ -98,7 +96,7 @@ Check the planned work [here](https://github.com/orgs/editor-code-assistant/proj
9896
## Contributing
9997

10098
Contributions are very welcome, please open an issue for discussion or a pull request.
101-
For developer details, check [this doc](https://eca.dev/development).
99+
For developer details, check [development docs](https://eca.dev/development).
102100

103101
## Support the project 💖
104102

0 commit comments

Comments
 (0)