khoj/README.md

<p align="center"><img src="src/khoj/interface/web/assets/icons/khoj-logo-sideways-500.png" width="230" alt="Khoj Logo"></p>

<div align="center">

[![test](https://github.com/khoj-ai/khoj/actions/workflows/test.yml/badge.svg)](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)
[![dockerize](https://github.com/khoj-ai/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/khoj-ai/khoj/pkgs/container/khoj)
[![pypi](https://github.com/khoj-ai/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj/)
![Discord](https://img.shields.io/discord/1112065956647284756?style=plastic&label=discord)

</div>

<div align="center">
<b>The open-source, personal AI for your digital brain</b>
</div>

<br />

<div align="center">

[📑 Docs](https://docs.khoj.dev)
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
[🏮 App](https://khoj.dev)
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
[💬 Discord](https://discord.gg/BDgyabRM6e)
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
[📚 Blog](https://blog.khoj.dev)

</div>

<div align="left">

***

[Khoj](https://khoj.dev) is a personal, open-source AI application for you to extend your capabilities.
- Share your documents to extend your digital brain.
- Access the internet, getting fresh information.
- You can share pdf, markdown, org-mode, notion files and github repositories.
- Fast, accurate semantic search on top of your docs.
- Create images, talk out loud, play your messages.
- Available Desktop, Emacs, Obsidian, Web and Whatsapp.
- Khoj is open-source, self-hostable. Always.

***

</div>

## See it in action

![demo_chat](https://github.com/khoj-ai/khoj/blob/master/documentation/assets/img/quadratic_equation_khoj_web.gif?raw=true)

Go to https://app.khoj.dev to see Khoj live.

## Full feature list
You can see the full feature list [here](https://docs.khoj.dev/category/features).

## Self-Host

To get started with self-hosting Khoj, [read the docs](https://docs.khoj.dev/get-started/setup).

## Contributors
Cheers to our awesome contributors! 🎉

<a href="https://github.com/khoj-ai/khoj/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=khoj-ai/khoj" />
</a>

Made with [contrib.rocks](https://contrib.rocks).

### Interested in Contributing?

We are always looking for contributors to help us build new features, improve the project documentation, or fix bugs. If you're interested, please see our [Contributing Guidelines](https://docs.khoj.dev/contributing/development) and check out our [Contributors Project Board](https://github.com/orgs/khoj-ai/projects/4).
Use 500px png of khoj logo instead svg for much smaller asset size The khoj logo svg was 1.3Mb. The 500px png of it is 38Kb. Given all usage of khoj-logo are below 230px this should work fine 2023-08-08 03:21:15 +02:00			`<p align="center"><img src="src/khoj/interface/web/assets/icons/khoj-logo-sideways-500.png" width="230" alt="Khoj Logo"></p>`
Use new Khoj Lantern Logo in Web, Emacs, Obsidian UIs and Docs 2023-06-21 10:13:50 +02:00
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00			`<div align="center">`
Update docs with setup instructions for Offline and Online Chat 2023-07-29 19:49:40 +02:00
Rename project links across repo from debanjum/khoj to khoj-ai/khoj 2023-06-21 09:13:21 +02:00			`[![test](https://github.com/khoj-ai/khoj/actions/workflows/test.yml/badge.svg)](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)`
			`[![dockerize](https://github.com/khoj-ai/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/khoj-ai/khoj/pkgs/container/khoj)`
Migrate the pypi package to khoj project name. Update references - Deprecate khoj-assistant pypi package. Use more accurate and succinct pypi project name, khoj - Update references to sye khoj pypi package in docs and code instead of the legacy khoj-assistant pypi package - Update pypi workflow to publish to both khoj, khoj-assistant for now - Update stale python 3.9 support mentioned in our pyproject. Can't support python 3.9 as depend on latest django which support >=3.10 2024-07-16 18:15:41 +02:00			`[![pypi](https://github.com/khoj-ai/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj/)`
Add num online for Discord badge 2024-03-10 13:18:30 +01:00			`![Discord](https://img.shields.io/discord/1112065956647284756?style=plastic&label=discord)`
Convert Readme to Markdown from Org as better support on Github 2022-07-29 15:06:34 +02:00
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00			`</div>`
Convert Readme to Markdown from Org as better support on Github 2022-07-29 15:06:34 +02:00
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00			`<div align="center">`
Update the readme for accuracy, updated demos 2024-04-04 07:27:24 +02:00			`<b>The open-source, personal AI for your digital brain</b>`
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00			`</div>`
Mention Emacs, Obsidian plugins at top of main Readme Add badges for supported plugins at top of main readme. Link badges to plugin docs for easy navigation for plugin users from main readme/project root 2023-01-29 03:01:20 +01:00
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00			`<br />`

			`<div align="center">`

Update the demo and simplify the readme 2024-09-12 05:03:48 +02:00			`[📑 Docs](https://docs.khoj.dev)`
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00			`<span>  •  </span>`
Update the demo and simplify the readme 2024-09-12 05:03:48 +02:00			`[🏮 App](https://khoj.dev)`
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00			`<span>  •  </span>`
Update the demo and simplify the readme 2024-09-12 05:03:48 +02:00			`[💬 Discord](https://discord.gg/BDgyabRM6e)`
Update the readme for accuracy, updated demos 2024-04-04 07:27:24 +02:00			`<span>  •  </span>`
Update the demo and simplify the readme 2024-09-12 05:03:48 +02:00			`[📚 Blog](https://blog.khoj.dev)`
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00
			`</div>`

Update the readme for accuracy, updated demos 2024-04-04 07:27:24 +02:00			`<div align="left">`
Update docs with setup instructions for Offline and Online Chat 2023-07-29 19:49:40 +02:00
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00			`***`

Update the demo and simplify the readme 2024-09-12 05:03:48 +02:00			`[Khoj](https://khoj.dev) is a personal, open-source AI application for you to extend your capabilities.`
			`- Share your documents to extend your digital brain.`
			`- Access the internet, getting fresh information.`
Update the readme for accuracy, updated demos 2024-04-04 07:27:24 +02:00			`- You can share pdf, markdown, org-mode, notion files and github repositories.`
Update the demo and simplify the readme 2024-09-12 05:03:48 +02:00			`- Fast, accurate semantic search on top of your docs.`
			`- Create images, talk out loud, play your messages.`
			`- Available Desktop, Emacs, Obsidian, Web and Whatsapp.`
Update the readme for accuracy, updated demos 2024-04-04 07:27:24 +02:00			`- Khoj is open-source, self-hostable. Always.`
Add screenshots, style content in README 2023-07-29 10:22:48 +02:00
			`***`

			`</div>`

Update the readme for accuracy, updated demos 2024-04-04 07:27:24 +02:00			`## See it in action`

Update link to gif demo in README to pull from GitHub 2024-09-12 05:09:26 +02:00			`![demo_chat](https://github.com/khoj-ai/khoj/blob/master/documentation/assets/img/quadratic_equation_khoj_web.gif?raw=true)`
Update the readme for accuracy, updated demos 2024-04-04 07:27:24 +02:00
			`Go to https://app.khoj.dev to see Khoj live.`

			`## Full feature list`
			`You can see the full feature list [here](https://docs.khoj.dev/category/features).`

			`## Self-Host`

			`To get started with self-hosting Khoj, [read the docs](https://docs.khoj.dev/get-started/setup).`
Add contributors to the README 2023-11-26 21:05:36 +01:00
			`## Contributors`
			`Cheers to our awesome contributors! 🎉`

			`<a href="https://github.com/khoj-ai/khoj/graphs/contributors">`
			`<img src="https://contrib.rocks/image?repo=khoj-ai/khoj" />`
			`</a>`

			`Made with [contrib.rocks](https://contrib.rocks).`
Add Sponsors Section to Readme 2024-04-08 12:09:24 +02:00
Add links for contributors to use in the readme 2024-04-12 09:19:12 +02:00			`### Interested in Contributing?`

			`We are always looking for contributors to help us build new features, improve the project documentation, or fix bugs. If you're interested, please see our [Contributing Guidelines](https://docs.khoj.dev/contributing/development) and check out our [Contributors Project Board](https://github.com/orgs/khoj-ai/projects/4).`