-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update README.md with new format and badges
- Changed the title format to HTML with centered alignment. - Added badges for tests, LuaRocks release, GitHub release, and Reddit post. - Added a note about heavy refactoring and a reference to the previous version. - Updated the acknowledgments section to include a new inspiration source. - Removed detailed sections on idea, features, requirements, installation, usage, and warnings.
- Loading branch information
Showing
1 changed file
with
23 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,116 +1,38 @@ | ||
| # ✒️ Dante | ||
| <h1 align="center">✎ dante.nvim ✧</h1> | ||
|
|
||
| An unpolished grammar checker powered by OpenAI models and [Neovim's builtin diff tool](https://neovim.io/doc/user/diff.html). Seriously, it's just a proof of concept. | ||
| <!--TODO: Update links and badges--> | ||
|
|
||
| https://github.com/S1M0N38/dante.nvim/assets/22257750/33ed003f-5160-428f-b3a2-dc4bb697f76b | ||
| <p align="center"> | ||
| <a href="https://github.com/S1M0N38/dante.nvim/releases"> | ||
| <img alt="Tests workflow" src="https://img.shields.io/github/actions/workflow/status/S1M0N38/ai.nvim/tests.yml?style=for-the-badge&label=Tests"/> | ||
| </a> | ||
| <a href="https://luarocks.org/modules/S1M0N38/ai.nvim"> | ||
| <img alt="LuaRocks release" src="https://img.shields.io/luarocks/v/S1M0N38/ai.nvim?style=for-the-badge&color=5d2fbf"/> | ||
| </a> | ||
| <a href="https://github.com/S1M0N38/ai.nvim/releases"> | ||
| <img alt="GitHub release" src="https://img.shields.io/github/v/release/S1M0N38/ai.nvim?style=for-the-badge&label=GitHub"/> | ||
| </a> | ||
| <a href="https://www.reddit.com/r/neovim/comments/..."> | ||
| <img alt="Reddit post" src="https://img.shields.io/badge/post-reddit?style=for-the-badge&label=Reddit&color=FF5700"/> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## 💡 Idea | ||
| <!--TODO: update the rest of the README.md--> | ||
|
|
||
| I wanted to experiment with the newly released [GPT Assistant API](https://platform.openai.com/docs/assistants/overview). Vim/Neovim's builtin diff tool is a good way to highlight the differences between the original text and the suggested one. | ||
| ______________________________________________________________________ | ||
|
|
||
| **Edit**: I moved from the GPT Assistant API back to the *chat completions* API because it was easier to implement the API in a non-blocking fashion. | ||
| > [!IMPORTANT] | ||
| > This is heavy refactoring of the original dante.nvim plugin (still WIP). | ||
| > If you want to use the previous version stick to a6955468391665d6465b371e81d1a80eac4cf0f1 commit. | ||
| *The detailed reasons why I decided to develop dante.nvim are explained in this [Reddit post](https://www.reddit.com/r/neovim/comments/182p87j/dantenvim_a_simple_ai_writing_assistant/).* | ||
|
|
||
| ## ✨ Features | ||
|
|
||
| - Prompt selected line into LLM and highlight the differences with the original text. | ||
|
|
||
| ## ⚡️ Requirements | ||
|
|
||
| - Neovim >= **0.9** | ||
| - curl | ||
| - Access to OpenAI API or compatible API (e.g., [LiteLLM](https://docs.litellm.ai/docs/simple_proxy)) | ||
|
|
||
| ## 📦 Installation | ||
|
|
||
| 1. Install using a plugin manager | ||
|
|
||
| ```lua | ||
| -- using lazy.nvim | ||
| { | ||
| "s1m0n38/dante.nvim", | ||
| opts = { | ||
| -- these are the global options and will be used as default in every preset | ||
| -- If global options are not specified, the plugin will use the default values | ||
| model = "gpt-3.5-turbo", | ||
| temperature = 0, | ||
|
|
||
| presets = { | ||
| default = { | ||
| -- when options are not specified, the global config will be used | ||
| }, | ||
| readme = { | ||
| -- these options will override the global config | ||
| model = "gpt-4", | ||
| temperature = 0.3, | ||
| prompt = "You are tasked as an assistant primarily responsible for rectifying errors within English text. Please amend spelling inaccuracies and augment grammar; ensure that the refined text closely adheres to the original version. Given that the text is authored in Markdown intended for a README file, please abide by the Markdown syntax accordingly. Provide your corrections in the form of the enhanced text only, devoid of commentary. Maintain the integrity of the original text's new lines and the spacing. Do NOT enclose the generated text into triple ticks.", | ||
| }, | ||
| -- Add more presets here... | ||
| }, | ||
| }, | ||
|
|
||
| -- Not required but it improves upon built-in diff view with char diff | ||
| dependencies = { | ||
| { | ||
| "rickhowe/diffchar.vim", | ||
| keys = { | ||
| { "[z", "<Plug>JumpDiffCharPrevStart", desc = "Previous diff", silent = true }, | ||
| { "]z", "<Plug>JumpDiffCharNextStart", desc = "Next diff", silent = true }, | ||
| -- { "do", "<Plug>GetDiffCharPair", desc = "Obtain diff", silent = true }, | ||
| -- { "dp", "<Plug>PutDiffCharPair", desc = "Put diff", silent = true }, | ||
| { | ||
| "do", | ||
| "<Plug>GetDiffCharPair | <Plug>JumpDiffCharNextStart", | ||
| desc = "Obtain diff and Next diff", | ||
| silent = true, | ||
| }, | ||
| { | ||
| "dp", | ||
| "<Plug>PutDiffCharPair | <Plug>JumpDiffCharNextStart", | ||
| desc = "Put diff and Next diff", | ||
| silent = true, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| ``` | ||
|
|
||
| 2. [Get an OpenAI API key](https://platform.openai.com/docs/api-reference/introduction) and add it to your environment as `OPENAI_API_KEY`. | ||
|
|
||
| ## 🚀 Usage | ||
|
|
||
| **Normal Mode** | ||
|
|
||
| - `:Dante <preset>` sends the current line to LLM. If no preset is specified, the `default` preset will be used. | ||
|
|
||
| **Visual Mode** | ||
|
|
||
| - `:'<,'>Dante <preset>` sends the selected lines to LLM. If no preset is specified, the `default` preset will be used. | ||
|
|
||
| Read the Neovim [documentation](https://neovim.io/doc/user/diff.html) to learn how to navigate between and edit differences. | ||
|
|
||
| For obtaining the best results, you should: | ||
|
|
||
| - Carefully write your own prompt for your specific use case. | ||
| - Avoid breaking lines at a fixed column (e.g., 80). Instead, use a new line when you feel it's necessary (just like writing with pen and paper) or a double new line for paragraph separation. | ||
| - Selecting smaller chunks of text focuses on the details, but you may miss the big picture. | ||
| - Use a powerful model like `gpt-4`, but it's more expensive and slower. | ||
| - For text files with a lot of lines, you may want to increase the "linematch" diffopt to 300 or more. This is a temporary workaround until I find a better solution. | ||
|
|
||
| ## ⚠️ Warnings | ||
|
|
||
| Be cautious of the text you are feeding into Dante. There is no mechanism to mitigate prompt injection, and the resulting text can be unexpected. | ||
|
|
||
|  | ||
|
|
||
| ## 🙏 Acknowledgments | ||
|
|
||
| This plugin was heavily inspired by: | ||
| This plugin was inspired by: | ||
|
|
||
| - [jackMort/ChatGPT.nvim](https://github.com/jackMort/ChatGPT.nvim) | ||
| - [David-Kunz/gen.nvim](https://github.com/David-Kunz/gen.nvim) | ||
| - [Bryley/neoai.nvim](https://github.com/Bryley/neoai.nvim) | ||
| - [olimorris/codecompanion.nvim](https://github.com/olimorris/codecompanion.nvim) | ||
|
|
||
| This very README is a copycat of [lazy.nvim](https://github.com/folke/lazy.nvim) README. |