From f26cee604d499784326d1696163efbdb6b1472b3 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Fri, 27 Jan 2023 20:01:31 -0300 Subject: [PATCH] Update Khoj Plugin Install Instructions. Rename main Readme to README Khoj plugin page from within Obsidian isn't recognized. Seems like it needs an uppercase readme file only. So it doesn't show the Khoj readme from within Obsidian itself. --- MANIFEST.in | 2 +- Readme.md => README.md | 0 setup.py | 2 +- src/interface/obsidian/README.md | 5 ++--- 4 files changed, 4 insertions(+), 5 deletions(-) rename Readme.md => README.md (100%) diff --git a/MANIFEST.in b/MANIFEST.in index 595ab4e1..5628f3d3 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include Readme.md +include README.md graft src/interface/* prune src/interface/web/images* prune docs* diff --git a/Readme.md b/README.md similarity index 100% rename from Readme.md rename to README.md diff --git a/setup.py b/setup.py index efe51cd5..a130ebfd 100644 --- a/setup.py +++ b/setup.py @@ -9,7 +9,7 @@ setup( name='khoj-assistant', version='0.2.6', description="A natural language search engine for your personal notes, transactions and images", - long_description=(this_directory / "Readme.md").read_text(encoding="utf-8"), + long_description=(this_directory / "README.md").read_text(encoding="utf-8"), long_description_content_type="text/markdown", author='Debanjum Singh Solanky, Saba Imran', author_email='debanjum+pypi@gmail.com, narmiabas@gmail.com', diff --git a/src/interface/obsidian/README.md b/src/interface/obsidian/README.md index 0159edba..60ecc93e 100644 --- a/src/interface/obsidian/README.md +++ b/src/interface/obsidian/README.md @@ -50,9 +50,8 @@ https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8 pip install khoj-assistant && khoj --no-gui ``` ### 2. Setup Plugin - 1. Open *Community plugins* tab in Obsidian settings panel - 2. Click Browse and Search for *Khoj* - 3. Click *Install*, after that click *Enable* on the Khoj plugin + 1. Open [Khoj](https://obsidian.md/plugins?id=khoj) from the *Community plugins* tab in Obsidian settings panel + 2. Click *Install*, then *Enable* on the Khoj plugin page in Obsidian See [official docs](https://help.obsidian.md/Advanced+topics/Community+plugins#Discover+and+install+community+plugins) for details