sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-23 15:38:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update Khoj Plugin Install Instructions. Rename main Readme to README

Browse source 
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.
This commit is contained in:
Debanjum Singh Solanky 2023-01-27 20:01:31 -03:00
parent 2e13e15625
commit f26cee604d
4 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
MANIFEST.in
View file

@ -1,4 +1,4 @@
include Readme.md
include README.md
graft src/interface/*
prune src/interface/web/images*
prune docs*

0
Readme.md → README.md
View file

2
setup.py
View file

@ -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',

5
src/interface/obsidian/README.md
View file

@ -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