mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-30 10:53:02 +01:00
Add Upgrade instructions for Obsidian, Emacs to main Readme
This commit is contained in:
parent
0e39e0ff71
commit
3dd69f7505
1 changed files with 14 additions and 2 deletions
16
Readme.md
16
Readme.md
|
@ -21,6 +21,9 @@
|
||||||
- [Interfaces](#Interfaces-1)
|
- [Interfaces](#Interfaces-1)
|
||||||
- [Query Filters](#Query-filters)
|
- [Query Filters](#Query-filters)
|
||||||
- [Upgrade](#Upgrade)
|
- [Upgrade](#Upgrade)
|
||||||
|
- [Khoj Server](#upgrade-khoj-server)
|
||||||
|
- [Khoj.el](#upgrade-khoj-on-emacs)
|
||||||
|
- [Khoj Obsidian](#upgrade-khoj-on-obsidian)
|
||||||
- [Troubleshoot](#Troubleshoot)
|
- [Troubleshoot](#Troubleshoot)
|
||||||
- [Advanced Usage](#advanced-usage)
|
- [Advanced Usage](#advanced-usage)
|
||||||
- [Access Khoj on Mobile](#access-khoj-on-mobile)
|
- [Access Khoj on Mobile](#access-khoj-on-mobile)
|
||||||
|
@ -89,7 +92,7 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
|
||||||
## Setup
|
## Setup
|
||||||
These are the general setup instructions for Khoj.
|
These are the general setup instructions for Khoj.
|
||||||
|
|
||||||
Check the [Khoj Obsidian Readme]((https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with the Obsidian Plugin. Its simpler as it can skip the configure step below.
|
Check the [Khoj Obsidian Readme](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with the Obsidian Plugin. Its simpler as it can skip the configure step below.
|
||||||
|
|
||||||
### 1. Install
|
### 1. Install
|
||||||
|
|
||||||
|
@ -142,11 +145,20 @@ Use structured query syntax to filter the natural language search results
|
||||||
- that best match the natural language query *"what is the meaning of life?"*
|
- that best match the natural language query *"what is the meaning of life?"*
|
||||||
|
|
||||||
## Upgrade
|
## Upgrade
|
||||||
|
### Upgrade Khoj Server
|
||||||
```shell
|
```shell
|
||||||
pip install --upgrade khoj-assistant
|
pip install --upgrade khoj-assistant
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Upgrade Khoj on Emacs
|
||||||
|
- Use your Emacs Package Manager to Upgrade
|
||||||
|
- E.g Run `M-x package-refresh-content` followed by `M-x package-reinstall khoj` to upgrade `khoj.el`
|
||||||
|
- See [khoj.el readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade) for details
|
||||||
|
|
||||||
|
### Upgrade Khoj on Obsidian
|
||||||
|
- Upgrade via the Community plugins tab on the settings pane in the Obsidian app
|
||||||
|
- See the [khoj plugin readme](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) for details
|
||||||
|
|
||||||
## Troubleshoot
|
## Troubleshoot
|
||||||
|
|
||||||
- Symptom: Errors out complaining about Tensors mismatch, null etc
|
- Symptom: Errors out complaining about Tensors mismatch, null etc
|
||||||
|
|
Loading…
Reference in a new issue