aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index f263a08..bc72579 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
# 🦙 ollama-logseq plugin
-A plugin to integrate ollama with logseq
+A plugin to integrate [ollama](https://github.com/jmorganca/ollama) with [logseq](https://github.com/logseq/logseq)
+
+# Get Started
+- First you will need to setup [ollama](https://github.com/jmorganca/ollama) you can check their github repo for instructions on how to setup ollama
+- That's it once you setup ollama you should be able to use the plugin with no problem
+
+# Features
+- The plugin currently has 5 commands
+ - Ask Ai -> which is a prompt the AI freely without any context
+ - Ask Ai with context -> This is the same as Ask Ai but it gives the model the context of the current page
+ - Summarize -> Summarizs the whole page
+ - Create a flash card
+ - Divide a todo task into subtasks
+- Respects theming
+- Settings for changing the host of the model, the model itself and a shortcut to open the plugin command pallete
+
+
+# Demo
+![demo](./docs/demo.mkv)
+
+
+If you have any features suggestions feel free to open an issue
+