|
1 | | -# 🤖 ECA Neovim Plugin |
| 1 | +# ECA Neovim Plugin |
2 | 2 |
|
3 | 3 | <img width="800" alt="demo" src="https://github.com/user-attachments/assets/d8417f8d-54cd-45fe-88a4-5e8dc245d73d" /> |
4 | 4 |
|
5 | | -A modern Neovim plugin that integrates [ECA (Editor Code Assistant)](https://eca.dev/) directly into the editor for an intuitive, streaming AI experience. |
| 5 | +A lightweight Neovim plugin that embeds [ECA (Editor Code Assistant)](https://eca.dev/) directly into your editor. It is designed to be very simple, while remaining highly customizable. |
6 | 6 |
|
7 | | -## ✨ Features |
8 | | -- 🤖 Integrated AI chat in Neovim |
9 | | -- 📁 Add files, directories and selections as context |
10 | | -- 🚀 Automatic ECA server download and start |
11 | | -- 🎨 Clean sidebar UI with Markdown rendering |
12 | | -- ⌨️ Intuitive defaults (Ctrl+S to send, Enter for newline) |
13 | | -- 🔧 Highly configurable windows, keymaps and behavior |
14 | | -- 📊 Usage and status feedback |
| 7 | +> Status: **Work in Progress** — we’re actively developing this plugin and would love feedback, bug reports, and contributions. If you’d like to help, check out [Development & contributing](./docs/development.md) or open an issue/PR. |
15 | 8 |
|
16 | | -## ⚡ Quick Start |
17 | | -1. Install via your plugin manager (see Installation below) |
18 | | -2. Restart Neovim |
19 | | -3. Run `:EcaChat` or press `<leader>ec` |
20 | | -4. Type your message and press `Ctrl+S` |
21 | | -5. Add context with `:EcaAddFile` or `:EcaAddSelection` |
| 9 | +## Quick Start |
22 | 10 |
|
23 | 11 | > Requires Neovim >= 0.8.0, curl and unzip. |
24 | 12 |
|
25 | | -## 📚 Documentation |
| 13 | +1. Install via your plugin manager (see Installation below) |
| 14 | +2. Run `:EcaChat` or press `<leader>ec` |
| 15 | +3. Type your message and press `Ctrl+S` |
| 16 | + |
| 17 | + |
| 18 | +## Documentation |
26 | 19 | - [Installation and system requirements](./docs/installation.md) |
27 | 20 | - [Usage guide (commands, keymaps, tips)](./docs/usage.md) |
28 | 21 | - [Configuration reference and presets](./docs/configuration.md) |
29 | 22 | - [Troubleshooting common issues](./docs/troubleshooting.md) |
30 | 23 | - [Development & contributing](./docs/development.md) |
31 | 24 |
|
32 | | -## 🔗 Useful Links |
| 25 | +## Useful Links |
33 | 26 | - [Official ECA Website](https://eca.dev/) |
34 | 27 | - [ECA Documentation](https://docs.eca.dev/) |
35 | 28 | - [VS Code Plugin](https://marketplace.visualstudio.com/items?itemName=editor-code-assistant.eca-vscode) |
36 | 29 | - [ECA GitHub](https://github.com/editor-code-assistant) |
37 | 30 |
|
38 | | -## 📄 License |
| 31 | +## License |
39 | 32 | Apache License 2.0 — see [LICENSE](LICENSE) for details. |
40 | 33 |
|
41 | | -## 🙏 Acknowledgments |
42 | | -Inspired by: |
43 | | -- [avante.nvim](https://github.com/yetone/avante.nvim) — base structure and UI concepts |
44 | | -- [eca-vscode](https://github.com/editor-code-assistant/eca-vscode) — ECA server integration |
45 | | - |
46 | 34 | --- |
47 | 35 |
|
48 | 36 | <div align="center"> |
49 | 37 |
|
50 | | -✨ Made with ❤️ for the Neovim community ✨ |
| 38 | +Made for the Neovim community |
51 | 39 |
|
52 | | -[⭐ Give a star if this plugin was useful!](https://github.com/editor-code-assistant/eca-nvim) |
| 40 | +[Give a star if this plugin was useful](https://github.com/editor-code-assistant/eca-nvim) |
53 | 41 |
|
54 | 42 | </div> |
0 commit comments