Added License and provided a demo video in the readme

3 files changed, 44 insertions, 1 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0d24894
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Omar Magdy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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
+
diff --git a/docs/demo.mkv b/docs/demo.mkv
new file mode 100644
index 0000000..f269785
--- /dev/null
+++ b/docs/demo.mkv