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

Add Feature Section to Readme

Browse source 
- Make Architecture a top-level section
- Minor improvement to Configure section
This commit is contained in:
Debanjum 2022-07-25 15:43:27 -07:00 • committed by GitHub
parent f953b20415
commit d8efcd559f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.org
View file

@ -1,15 +1,19 @@
[[https://github.com/debanjum/khoj/actions/workflows/test.yml/badge.svg]] [[https://github.com/debanjum/khoj/actions/workflows/build.yml/badge.svg]]
* Khoj
/Natural language search engine for your personal notes, transactions and images using transformer ML models/
/Natural language search engine for your personal notes, transactions and images/
Interface with Khoj via [[./src/interface/web/index.html][Web]], [[./src/interface/emacs/khoj.el][Emacs]] or the [[http://localhost:8000/docs][API]]. All search is done locally[[https://github.com/debanjum/khoj#miscellaneous][*]]
** Features
- Advanced Natural language understanding using Transformer based ML Models
- Your personal data stays local. All search, indexing is done on your machine[[https://github.com/debanjum/khoj#miscellaneous][*]]
- Index Org-mode and Markdown notes, Beancount transactions and Photos
- Interact with Khoj using a [[./src/interface/web/index.html][Web Browser]], [[./src/interface/emacs/khoj.el][Emacs]] or the [[http://localhost:8000/docs][API]].
** Demo
https://user-images.githubusercontent.com/6413477/168417719-8a8bc4e5-8404-42b2-89a7-4493e3d2582c.mp4
*** Architecture
[[https://github.com/debanjum/khoj/blob/master/docs/khoj_architecture.png]]
** Architecture
[[https://github.com/debanjum/khoj/blob/master/docs/khoj_architecture.png]]
** Setup
@ -19,8 +23,8 @@
#+end_src
*** 2. Configure
- [Required] Update [[./docker-compose.yml][docker-compose.yml]] to mount your images, (org-mode or markdown) notes and beancount directories
- [Optional] Edit application configuration in [[./config/sample_config.yml][sample_config.yml]]
- *Required*: Update [[./docker-compose.yml][docker-compose.yml]] to mount your images, (org-mode or markdown) notes and beancount directories
- *Optional*: Edit application configuration in [[./config/sample_config.yml][sample_config.yml]]
*** 3. Run
#+begin_src shell