sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2025-02-20 06:55:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Update main readme to mention chat features

Browse source
This commit is contained in:
Debanjum Singh Solanky 2023-03-27 20:51:27 +07:00
parent fc218508f9
commit 7478d08803
1 changed files with 16 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -3,7 +3,7 @@
[![dockerize](https://github.com/debanjum/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/debanjum/khoj/pkgs/container/khoj) [![dockerize](https://github.com/debanjum/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/debanjum/khoj/pkgs/container/khoj)
[![pypi](https://github.com/debanjum/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj-assistant/) [![pypi](https://github.com/debanjum/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj-assistant/)
*A natural language search engine for your personal notes, transactions and images* *A search assistant for your second brain*
**Supported Plugins** **Supported Plugins**
@ -53,13 +53,18 @@
- [Credits](#Credits) - [Credits](#Credits)
## Features ## Features
- **Search**
- **Natural**: Advanced natural language understanding using Transformer based ML Models - **Local**: Your personal data stays local. All search and indexing is done on your machine. *Unlike chat which requires access to GPT.*
- **Local**: Your personal data stays local. All search, indexing is done on your machine[\*](https://github.com/debanjum/khoj#beta-api) - **Incremental**: Incremental search for a fast, search-as-you-type experience
- **Incremental**: Incremental search for a fast, search-as-you-type experience - **Chat**
- **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models - **Faster answers**: Find answers faster, smoother than search. No need to manually scan through your notes to find answers.
- **Multiple Sources**: Search your Org-mode and Markdown notes, Beancount transactions and Photos - **Iterative discovery**: Iteratively explore and (re-)discover your notes
- **Multiple Interfaces**: Search from your [Web Browser](./src/khoj/interface/web/index.html), [Emacs](./src/interface/emacs/khoj.el) or [Obsidian](./src/interface/obsidian/) - **Assisted creativity**: Smoothly weave across answers retrieval and content generation
- **General**
- **Natural**: Advanced natural language understanding using Transformer based ML Models
- **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models
- **Multiple Sources**: Index your Org-mode and Markdown notes, Beancount transactions and Photos
- **Multiple Interfaces**: Interact from your [Web Browser](./src/khoj/interface/web/index.html), [Emacs](./src/interface/emacs/khoj.el) or [Obsidian](./src/interface/obsidian/)
## Demos ## Demos
### Khoj in Obsidian ### Khoj in Obsidian
@ -108,9 +113,10 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
These are the general setup instructions for Khoj. These are the general setup instructions for Khoj.
- Make sure [python](https://realpython.com/installing-python/) (version 3.10 or lower) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine - Make sure [python](https://realpython.com/installing-python/) (version 3.10 or lower) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine
- Check the [Khoj.el Readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Setup) to setup Khoj with Emacs - Check the [Khoj.el Readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Setup) to setup Khoj with Emacs<br />
Its simpler as it can skip the server *install*, *run* and *configure* step below.
- Check the [Khoj Obsidian Readme](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with Obsidian<br /> - Check the [Khoj Obsidian Readme](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with Obsidian<br />
Its simpler as it can skip the configure step below. Its simpler as it can skip the *configure* step below.
### 1. Install ### 1. Install