Skip to content

Commit

Permalink
enh: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
marco-souza committed Nov 30, 2023
1 parent bec0821 commit 9db9d11
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# 👁️llero 🦙

Ollero (ollero.nvim) is a Neovim Plugin that unleashes Ollama powers to your
> **🚧 Warning**: This project is highly under construction, but feel free to
> test it
Ollero (`ollero.nvim`) is a Neovim Plugin that unleashes Ollama powers to your
text editor.

The backlog of this project includes features like:

- interact with offline LLM through Ollama API
- manage LLMs in Neovim
- selected to prompt
- selected to prompt (WIP 🚧)
- manage AI Prompts (WIP 🚧)
- text completion (WIP 🚧)

## Dependencies

You must have `ollama` installed and running on your machine

> You can donwload and install Ollama from https://ollama.ai/
> You can download and install Ollama from https://ollama.ai/
Also, this plugin relies on some other libraries that should be listed as
dependencies
Expand All @@ -26,7 +29,6 @@ dependencies
"marco-souza/ollero.nvim",
name = "ollero",
dependencies = {
"nvim-lua/plenary.nvim",
"nvim-telescope/telescope-ui-select.nvim",
},
config = function()
Expand All @@ -43,13 +45,15 @@ Install it with your plugin manager, then add a keymap to the following command:
## Commands

# managing ollama models
:Chat
:RunModel <name> # WIP 🚧
:ListModels
:RemoveModel
:InstallModel
:RemoveModel
:ListModels
:RunModel

# interact with models
:Chat

# manafing model files
# custom model files
:CreateModel
:BuildModel
```
2 changes: 1 addition & 1 deletion lua/ollero/ollero.lua
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ function Ollero.install_model()
end

ollama.install(model, function(cmd)
vim.notify("Ollama is installing `" .. model("`..."))
vim.notify("Ollama is installing `" .. model .. "`...")
term.send(term.termcode("<C-d>"))
term.send(cmd)
end)
Expand Down

0 comments on commit 9db9d11

Please sign in to comment.