From eb9aadf72a6c7ab08c11f3de65c85ac5cf71c77a Mon Sep 17 00:00:00 2001
From: sabaimran <narmiabas@gmail.com>
Date: Sun, 5 Jan 2025 19:06:27 -0800
Subject: [PATCH] Add an Obsidian README documentation for development

---
 src/interface/obsidian/README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 src/interface/obsidian/README.md

diff --git a/src/interface/obsidian/README.md b/src/interface/obsidian/README.md
new file mode 100644
index 00000000..14cc12c5
--- /dev/null
+++ b/src/interface/obsidian/README.md
@@ -0,0 +1,20 @@
+# Obsidian Development
+
+You can use the [Obsidian Khoj plugin](https://obsidian.md/plugins?id=khoj) to share your Obsidian knowledge base with your AI assistant. The plugin will index your notes and make them searchable by your AI assistant.
+
+## Development
+
+In `src/interface/obsidian`, run:
+
+```bash
+yarn install
+yarn build
+```
+
+You'll want to link the built plugin to your Obsidian vault. You can do this by symlinking the built folder to your Obsidian vault's plugins folder. For example:
+
+```bash
+ln -s /path/to/khoj-assistant/src/interface/obsidian /path/to/obsidian-vault/.obsidian/plugins/obsidian-assistant
+```
+
+Now, once you reload your Obsidian, you should see your updated plugin code running.