Skip to content

Commit

Permalink
enh: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marco-souza committed Sep 30, 2024
1 parent 534e19f commit b91c4e0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,21 @@ text editor.

The backlog of this project includes features like:

- interact with offline LLM through Ollama API
- manage LLMs in Neovim
- (new 🚀) generate `Modelfile` based on prompt input _(using [marco-souza/omg](https://github.com/marco-souza/omg))_
- ~selected to prompt~ _(Implemented by [David-Kunz/gen.nvim](https://github.com/David-Kunz/gen.nvim))_
- ~manage AI Prompts~ _(Implemented by [David-Kunz/gen.nvim](https://github.com/David-Kunz/gen.nvim))_
- text completion (WIP 🚧)
- interact with offline LLM using Ollama - https://ollama.com/
- manage Ollama models in Neovim
- Chat with the default model using `<M-a>`
- selected to prompt using `<M-s>`
- list online and offline models
- build and run custom ollama modelfile
- generate `Modelfile` based on prompt input _(using [marco-souza/omg](https://github.com/marco-souza/omg))

## Demo

https://www.loom.com/share/a61362b16dc94c4b82426a03f0797099

## Dependencies

Ollero will run [ollama](https://ollama.ai/), so you must have `ollama` installed and running on your machine.
Ollero run [ollama](https://ollama.ai/), so you must have `ollama` installed and running on your machine.

Also, this plugin relies on some other libraries that should be listed as dependencies

Expand Down Expand Up @@ -85,6 +86,7 @@ Install it with your plugin manager, then add a keymap to the following command:

# interact with models
:Chat
:Ask

# custom model files
:CreateModel
Expand Down
9 changes: 5 additions & 4 deletions todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
- [x] diferentiate between installed and remote models
- [x] remove old ollama
- [x] review & refactor ollero module
- [ ] create tag-release CI automation
- [ ] create quality gateway
- [ ] clean up readme
- [x] create tag-release CI automation
- [x] create quality gateway
- [x] clean up readme


## Change Log - v2.0.0
## Change Log - v1.0.0

### 🚀 Features:

Expand All @@ -37,6 +37,7 @@
- refactored ollero module
- refactored ollama module
- move logger to a shared module
- add ci workflows for tag release and quality gateway

## Useful Links

Expand Down

0 comments on commit b91c4e0

Please sign in to comment.